Rallye-Server

The rallye server is a django tool for rating the performance of groups participating in the campus rallye. The campus rallye is part of the program of the Study Introduction Days of the Mathematics/Phyics/Informatics Departmental Student Council at Technical University Munich.

The campus rallye consists of stations, which are supervised by tutors. Participating students form groups of four to six people. Each group absolves different stations where they can get at max 10 points per stations. The tutors log in to the rallye server and fill in the ratings of the groups. Additionally, the tutors have the possibility to update the ratings if they filled in the wrong number of points of to delete the rating if they rated the wrong group in the tool.
At the end of the campus rallye, a prize giving ceremony follows. This ceremony is supported by the automatic evaluation of the total ratings ot the groups.

Installation

0. Clone and go into the cloned directory

git clone https://github.com/FSTUM/rallyetool-v2.git
cd rallyetool-v2

1. Install system dependencies

sudo apt-get update
sudo apt-get install -y python3-pip python3-venv

2. Install python-dependencies in an virtual environment

python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements.txt

Development

1. Install additional dependencies after you installed the dependencies listed in Installation

sudo apt-get install -y gettext npm
python3 -m pip install -r requirements_dev.txt

2. Set the DJANGO_SETTINGS_MODULE environment option:

This Step is needed, because we have to have multiple settings files. The rallyetool.settings.keycloak_settings-file uses keycloak, but because we DONT want to commit the secrets to git, this config is not useful for development (except if you want to test if keycloak works).
The rallyetool.settings.dev_settings-file uses django's default modelbackend for authorisation. This backend can be populated with a user using the fixture, or the createsuperuser command mentioned below. The rallyetool.settings.staging_settings-file is only used in the staging environment.

export DJANGO_SETTINGS_MODULE=rallyetool.settings.dev_settings

3. Create the SQLite-database by running the following command inside the project directory:

python3 manage.py migrate

4. (Optional step, a user can be created using the fixture below) Create an admin-account by running the following command inside the project directory:

python3 manage.py createsuperuser

Note that this doesn't set the fist_name, thus the username is shown on the website. If you want your fist_name to be shown instead, you have to add your fist name in the admin interface.

5. Start the local webserver

python3 manage.py runserver

You can now visit http://localhost:8000/ in your browser

pre-commit

Code quality is ensured via various tools bundled in pre-commit.

You can install pre-commit, so it will automatically run on every commit:

pre-commit install

This will check all files modified by your commit and will prevent the commit if a hook fails. To check all files, you can run

pre-commit run --all-files

This will also be run by CI if you push to the repository.

Sample-Data/ "Fixtures"

you can generate example-data (overrides every model with data that looks partially plausible, but is clearly not production-data) by opening the django shell using:

python3 manage.py shell

In the shell type

import common.fixture as fixture
fixture.showroom_fixture_state()

This operation might take a few seconds. Don't worry.

Adding Dependencies

If you want to add a dependency that is in pip add it to the appropriate requirements-file.
If you want to add a dependency that is in npm run npm i DEPENDENCY. Make shure that you do only commit the necessary files to git.

Translation

1. Update the .po-files with

python manage.py makemessages -a

2. Edit the .po-file. Poedit is an excellent GUI for this!

   In the Settings please change:

   Setting	to value
   name	$NAME
   email	$EMAIL
   Line endings	Unix
   Wrap at	120
   check-spelling	True

3. Edit the .po-files, e.g. common/locale/de/LC_MESSAGES/django.po.

Note that pre-commit will automatically compile the translations for you.

Staging

A staging environment is offered at rallye.frank.elsinga.de.
The username is password.
The password is username.

Building and running the dockerfile for local development

1. you need to save your environment variables in an .env-file. The further guide assumes content similar to the following in staging/.env.

DJANGO_DEBUG="True"
DJANGO_SECRET_KEY="CHOOSE_A_SAVE_PASSWORD"
DJANGO_ALLOWED_HOSTS="0.0.0.0,localhost,127.0.0.1"

2. Build the dockerfile

docker build -t rallyetool-staging:v1 .

3. Run the Dockerfile

docker run --env-file staging/.env -p 8080:8000 rallyetool-staging:v1

The Staging instance is now available at 127.0.0.1:8080.
The latest branch is also build and pushed to the GitHub Container Registry for convenience.

Authors

Florian Angermeir Frank Elsinga

License

This project is licensed under the MIT License - see the LICENSE.md file for details.