Codebase Structure

This guide is going to be split into two parts - the backend and the frontend.

Backend

The backend has a couple of folders and important files:

File/folder	Description
app.py	The base file for our Flask server. All configuration variables (e.g. setting up JSON web tokens, emails) go here.
Pipfile	The file which contains all the libraries that we're using. You don't need to change it manually, this updates every time you use pipenv install or pipenv remove.
auth/	Contains all the code for authentication purposes (JWTs, the User class).
common/	Contains all the code that is shared amongst multiple API routes (e.g. all exceptions, variables that allow plugins like flask-mail to work properly).
puzzles/	Contains all the code for the actual puzzles (e.g. descriptions, implementation, input generation).
routes/	Contains all of our API routes.
test/	Contains all tests for Pytest.

Each file in routes should follow roughly the same pattern - declare a blueprint (which is essentially a way to make smaller sections of an API in Flask) and add all routes that belong to that blueprint underneath it.

Each file in test should cover exactly one API endpoint - for example, the file test/auth/register_test.py should cover all the tests for auth/register.

Frontend

To be filled in.