CONTRIBUTING.md

How to Contribute

We are glad you made all the way up to here, because every help is very welcome.

Setting up Your Development Environment

Installing Prerequisites

• Docker
• docker-compose

Installation

git clone https://github.com/studentenportal/web.git studentenportal

Run Environment

1. cd studentenportal
2. docker-compose up -d
3. Studentenportal is now available under http://localhost:8000

Logs

To show logs run the following command.

docker-compose logs

Additions

Dockerfiles / Requirement Changes

If your Dockerfiles or requirements change you have to update the docker containers as following.

docker-compose build --no-cache

Testing

Run Tests

docker-compose run --rm studentenportal_dev ./deploy/dev/test.sh

Test Users

Administrator

Username: user0
Email:    user0@localhost
Password: user0

Student

Username: user1
Email:    user1@localhost
Password: user1

Username: user2
Email:    user2@localhost
Password: user2

Coding Guidelines

Formatter

Our codebase is formatted by black.

Imports

To sort our imports we use isort