README.md

MakeOfficeHours

api/

A Flask API server that handles enqueuing and dequeuing students from the office hours queue.

Quick Started

1. You will first need to install all the development packages mainly use for

Project structure

Development

For this project please use the following python version: "3.10", "3.11", "3.12"

Running the development server:

docker compose up api-development--build

Pylint

Project uses pylint to keep the code style organized

You can run the Pylint on the api folder by doing the following

pylint $(git ls-files '*.py')

Formatter

Using the Black formatter https://github.com/psf/black

black $(git ls-files '*.py') 

Resource

Good resources to look at:

• https://flask.palletsprojects.com/en/stable/blueprints/
• https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-xv-a-better-application-structure