Smart Work is a project manager app built using the Javascript React framework. The app uses an API created with the Django-Rest Framework to load, create, edit, and delete data. The purpose of the site is to collaborate on projects with colleagues or friends, where users can add, update and delete tasks from projects, as well as view users' profiles and customize their own. The app is split into two separate sites. This repository is the back-end API section of the app.
https://smart-work-api.onrender.com/
https://smart-work-3d4938feb378.herokuapp.com/ https://smart-work.onrender.com/
https://github.com/AlexSmall96/Smart-Work-API
https://github.com/AlexSmall96/Smart-Work
The below diagram was used to plan the database schema.
Manual testing was carried out and documented in the below pdf. For each of the site models, the list and detail views were tested along with any filtering methods. In the below document, 'Base URL' refers to the main URL of the site.
All .py files pass through the Code Institute Python Linter with no issues.
- First create a database instance on https://www.elephantsql.com/
- Navigate to ElephantSQL.com and click “Get a managed database today”
- Select “Try now for FREE” in the TINY TURTLE database plan
- Select “Log in with GitHub” and authorize ElephantSQL with your selected GitHub account
- In the Create New team form:
- Add a team name (your own name is fine)
- Read and agree to the Terms of Service
- Select Yes for GDPR
- Provide your email address
- Click “Create Team”`
- Once logged in, click 'Create New Instance'
- Select a plan and name (this is usually the name of the project)
- Click select region and select the region closest to you
- Click review and create instance
- Once created, go to the dashboard, click on the database name, and copy the URL
- Create an account on https://cloudinary.com/ and copy the CLOUNDARY_URL from the dashboard
- On Heroku.com, click Create New App, and create using any name
- Go to the settings tab, click reveal config vars, and add the following key, and value pairs:
- CLIENT_ORIGIN: this is the URL of the deployed front-end site
- CLOUINARY_URL: the URL copied from Cloudinary
- DATABASE_URL: the database copied from Elephant SQL
- DISABLE_COLLECTSTATIC: set to 1
- SECRET_KEY: any value will do
- Open a new workspace from this repository and install any necessary packages from the requirements.txt file
- Create an env.py file and add the lines (if committing to GitHub ensure env.py is in the .gitignore file)
- import os
- os.environ['DATABASE_URL'] = 'your_database_url'
- Enter the command 'python manage.py migrate'. This will migrate the database structure into your newly created database.
- Go back to Heroku and click deploy. Copy the URL of the deployed site
- Go back to the Heroku app and add a final config var of: ALLOWED_HOST with the value being the URL you just copied
- Click open app to view the API.
- On GitHub.com, navigate to the main page of the repository.
- In the top-right corner of the page, click Fork.
- Select an owner for the forked repository.
- By default, forks are named the same as their upstream repositories. You can change the name of the fork to distinguish it further.
- Optionally, add a description of your fork.
- Choose whether to copy only the default branch or all branches to the new fork. For many forking scenarios, such as contributing to open-source projects, you only need to copy the default branch. By default, only the default branch is copied.
- Click Create Fork.
- On GitHub.com, navigate to the main page of the repository.
- Above the list of files, click Code.
- Copy the URL for the repository.
- Open Terminal.
- Change the current working directory to the location where you want the cloned directory.
- Type git clone, and then paste the URL you copied earlier.
- Press Enter to create your local clone.
The site was built with inspiration from the Code Institute Moments and Django Rest Framework walkthrough projects. Several models have been created with the walkthrough projects as source material, however, custom code was required to deal with deviations in the site functionality and database schema.
- https://dbdiagram.io/home was used to create the database schema diagram.
This application was created as a portfolio 5 project for the Diploma in Full Stack Software Development from Code Institute I would like to thank my mentor Gareth McGirr for his encouraging support and detailed feedback throughout this project. I would also like to thank the tutor support team for their helpful advice.