Follow instructions to install the latest version of python for your platform in the python docs
It's recommended that you work within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organized. Instructions for setting up a virtual environment for your platform can be found in the python docs
From within the /backend
directory first ensure you are working using your created virtual environment, by running
python3 -m venv venv && source venv/bin/activate
Once you have your virtual environment setup and running, install dependencies by naviging to the /backend
directory and running:
pip install -r requirements.txt
This will install all of the required packages we selected within the requirements.txt
file.
-
Flask is a lightweight backend microservices framework. Flask is required to handle requests and responses.
-
SQLAlchemy and Flask-SQLAlchemy are libraries to handle the lightweight sqlite database.
-
jose JavaScript Object Signing and Encryption for JWTs. Useful for encoding, decoding, and verifying JWTS.
Rename .env.example
to .env
cp .env.example .env
The necessary configuration for running the Flask App should already be set, FLASK_APP=src/app.py
and FLASK_DEBUG=True
To run the server, execute:
flask run