Front end system using ReactJs
npm version 8.19.2+
cd client
npm install # update dependencies
npm start
If an error related to dependencies is raised, run the following:
npm install --legacy-peer-deps
Backend server API using Python Flask
- Python 3.9+
- The required dependencies are included in the requirements.txt file
cd server
If using Pycharm, follow Virtual Environment Guide for creating the virtual environment
If creating through terminal:
python -m venv venv
Activate virtual environment using:
MacOS and Linux:
source venv/bin/activate
Windows:
venv\Scripts\activate
Install the required Python dependencies using:
pip install -r requirements.txt
python app.py
After cloning the repo, you'll be in the main branch
Create a new branch for your task and switch to it
git checkout -b <branch-name>
Now implement your tasks and insert code
Once finished, you will push it to your branch
Use git status to see which files you have changed
Track your changes using
git add <file-name>
Commit your changes to the repo, after adding all files
git commit -m "Descriptive message about your changes"
Push changes to repo and set upstream
git push -u origin <branch-name>
Now go to our repository in GitHub and your branch, create a Pull Request
Assign the Reviewer to Craig or Jacob
Add the Assignee as yourself