This project's API is based on the OpenAPI Specification
In the project's root directory, create an .env file, containing the following environment variables:
DEVELOPMENT: if this environment variable exists, sets the project to 'development' mode.DATABASE_URL: a path to the database of your choice.SECRET_KEY: a random string used as part of the JWT hashing functionality.ALGORITHM: the hashing algorithm used to store passwords.
From the root directory, run the pip install -r requirements.txt to install the required dependencies.
cd into the frontend directory and then install the node version you wish to use. The node version for this project can be found in the .nvmrc file.
Tip: You can quickly install the correct Node Version by running the following command while in the frontend directory: nvm i $(< .nvmrc)
While still in the frontend directory, and run the npm install (or npm i) command to install the required dependencies.
Finally, run the npm run dev command. This command will also simultaneously run the api server (note, this will only work if the required backend dependencies have been installed).
- SVGOMG: used to clean up all SVGs used in the project
- Favicomatic: used to create the project's favicon
- Thanks to Josh W. Comeau for his Modern CSS Reset
- Thanks to Eric Roby for his tutorials on hooking up FastAPI to both Postgres and Next.js