This repository hosts the backend code for the collaborative scheduling application developed by Instituto Mauá de Tecnologia and Fontys. This application allows the coordinator at Mauá to generate class schedules based on the availability of teachers.
- Create a virtual env
python -m venv venv
- Use the virtual env
To active run: source venv/bin/activate
To deactive run: deactivate
- Install the required packages
pip install -r requirements.txt
- Configure Environment variables
Copy the .env.EXAMPLE.env to .env
Open the file and update the values
Make sure you are inside of the virtual env as described in step 2 in the "Installing" chapter
python main.py
We use specific branches for different stages and types of work. Here’s an overview:
- Dev: The development branch used as a staging area
- Prod: The production branch holding the latest stable version
For ongoing work, create branches based on the task type:
- feature/ - For new features
Example: feature/generate-schedule
- bug/ - For bugfixes
Example: bug/fix-login-error
- chore/ - For refactoring, optimizing, or making small tweaks to existing code/features.
Example: chore/update-readme
Use lowercase kebab-case for naming branches, with the task type followed by a descriptive name.
- When you've completed work in a feature, bug or chore branch create a pull request to merge it into
dev - Assign the Ready For Review label to the pull request.
- Assign a team member who did not contribute to that branch as a reviewer. The reviewer should verify the changes before they can be merged.