UWin Success Backend

Setting up the project

You will need to use a virtual environment to run the project. To set up the virtual environment and install the requirements, run the following commands:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Running the project

To run the project, run the following command:

uvicorn main:app --reload

Collaboration Notes for Developers

To work on a new feature or a fix, ensure you're issuing a pull request to the dev branch. Your team will need to review your PR before it's is merged. You WILL NOT be able to push to the main branch. This is our deployment branch and will have an automation implemented later.