Web 2.0 Backend

Django backend containing multiple small applications and api for Next.js frontend.

• Web app: Backend for the main website.
• Member register: Data table app for viewing and modifying the member register, member applications and membership payments.
• Kaehmy: Form for creating and listing kaehmys
• Ohlhafv: Form for creating and listing ohlhafv challenges.
• Infoscreen: Angular-based slideshow app for the guild room's screens.

Installation

Set up your SSH key authentication in GitLab Profile Settings. Then clone the repository and checkout the development branch:

git clone git@gitlab.com:sahkoinsinoorikilta/vtmk/web2.0-backend.git
cd web2.0-backend

Copy env file for local use:

cp .env.dev .env

Poetry

For depedencies and virtual environment, we use poetry.

First install python. Then install poetry:

python -m pip install poetry==2.1.1

Install dependencies with

poetry install

Poetry is configured to install dependencies in a virtual environment, so you should see .venv folder in repo root.

Activate virtual environment in shell

eval $(poetry env activate)

Node

We use Node.js for few development tasks, like linting. Easiest way to install Node is nvm. After installing install dependencies:

npm install

See Linting for more info

Database

To run a local development database docker is recommended. If you want to additianally use a db management tool pgAdmin is nice.

After installing docker use the following to create a database:

docker run --name sik.web.db -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres:12

Development

Install dependencies with

poetry install

and make sure you are using Python from your virutal environment.

Virtual environment can be activated with

eval $(poetry env activate)

and you verify correct Python executable with

which python

# should return path similar to {your-system path}/web2.0-backend/.venv/bin/python

Initializing data

Run the following manage.py commands to initialize a new database. Do not run these in production without thinking!

python manage.py migrate            # run migrations
python manage.py createdefaultadmin # creates an admin user
python manage.py initialize         # creates user groups
python manage.py createdummydata    # creates dummy members to the member register

Running

python manage.py runserver

Visit https://localhost:8000 in your browser!

Using address 0.0.0.0 will bind to all IP addresses. Using localhost will only bind to your machine.

python manage.py runserver 0.0.0.0:8000

Development workflow

When you start working on a feature, create a feature branch for your changes. These feature branches should be prefixed with feature.

Example of creating a feature branch:

git checkout -b feature-branch-name

When your changes are ready and the code works without errors, submit a merge request to main in GitLab. Another developer reviews your changes and runs the merge. Feature branches should be closed on merge.

Bugfixes do not need their own feature branches and can be pushed straight to main, but if the fix needs a notable amount of work, it should be done in a bugfix branch instead.

Merge requests to main should be reviewed by multiple developers. Only a moderator can accept merge requests to production.

Linting

Lint python files using black with

npm run lint:py                     # check changes
npm run lint:py:fix                 # fix errors

Lint javascript and markdown using eslint and remark with

npm run lint:md                     # markdown
npm run lint:js                     # javascript

Use an editor with linting capabilities to write pretty code that passes linting. Examples include VSCode, Atom and Pycharm.

Unit tests

Run unit tests with

python manage.py test

Due to the mostly static nature of the project, most elements are difficult to properly unit test. If you write code with actual logic, make sure to write at least one unit or integration test that tests your code's core functionality.

Tests are located in tests.py under every subproject.

Production

Project is run in production with Docker. See Dockerfile for details.

For more information about deployment check infra repository.

GitLab CI

All pushed changes go through the GitLab Continuous Integration, which consists of automated unit testing and linting. Make sure your changes pass both before merging to main or production.