1. Clone the repo
git clone git@github.com:SELab-2/UGent-3.git2. Installing required packages
If you want the development environment: run both commands. If you only need to deploy, run the deployment command.
The dev-requirements.txt contains everything for writing tests and linters for maintaining quality code. On the other hand the regular requirements.txt installs the packages needed for the regular base application.
- Deployment
pip install -r requirements.txt- Development
pip install -r dev-requirements.txtThe project requires a couple of environment variables to run, if you want to develop on this codebase. Setting values for these variables can be done with a method to your own liking.
| Variable | Description |
|---|---|
| POSTGRES_USER | Name of the user, needed to login to the postgres database |
| POSTGRES_PASSWORD | Password of the user, needed to login to the postgres database |
| POSTGRES_HOST | Location of the postgres database |
| POSTGRES_DB | Name of the postgres database |
| API_HOST | Location of the API root |
| CLIENT_ID | Client id |
| CLIENT_SECRET | Client's secret is your personal secret key for authentication, this can be found at the Entra ID admin center |
| JWT_SECRET_KEY | JWT secret key is the key used to encode the JWT's and should be kept secret, because otherwise everyone can create "valid" JWT's for our application. Variable should be a random 32 characters long string, if you need more information please refer to the RDF documentation |
| TENANT_ID | Tenant id, an ID that is used to identify yourself to the microsoft servic |
| HOMEPAGE_URL | URL of where the website's homepage is located |
All the variables except the last one are for the database setup, these are needed to make a connection with the database. The last one is for keeping the API restful since the location of the resource should be located.
Once all the setup is done you can start the development server by navigating to the backend directory and running:
python projectThe server should now be located at localhost:5000 and you can
start developing.
When writing new code it is important to maintain the right functionality so writing tests is mandatory for this, the test library used in this codebase is pytest.
If you want to write tests we highly advise to read the pytest documentation on how to write tests, so they are kept conventional.
For executing the tests and testing your newly added functionality you can run:
sudo ./run_tests.shLocated in the backend directory.
This codebase is kept clean by the pylint linter.
If you want to execute the linter on all .py files in the project it can simply be done with the command:
find . -type f -name "*.py" | xargs pylintThe code needs to get a 10/10 score to get pushed to the repository.