Skip to content

About

KindEltern Web: Django and PostgreSQL CRM that replaces Excel/VBA and Access at an education centre. Family records, monthly fees and approval workflows; in development.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

KindEltern Web

A web CRM for Kinder- und Elternzentrum Kolibri e.V. in Dresden. It replaces the Excel/VBA workbooks and the Microsoft Access database the centre uses for families, courses and monthly fees with one shared Django application: every change is recorded, and changes to billing go through approval. The interface is in German.

Record list with fictional families

Screenshots from a local instance with invented families.

What it covers

  • Family and child records per school year, a family dashboard and family discounts.
  • A catalog of subjects, teachers, price options, discount types and semester settings.
  • Monthly amounts per record with month overrides, contract type and status timelines, and a family cost report.
  • Approval workflow: operators propose changes, admins and superadmins approve or decline them; the history of every record is kept, and in-app notifications tell people what is waiting for them.
  • Import from the legacy Access database.
  • Roles: read-only user, operator, admin and superadmin.
Record detail with monthly amounts and contract timeline

Record detail

Status

KindEltern Web is in active development and not deployed yet. The current work is the second version of the price list and billing logic ("PRICELIST v2"). Snapshot metadata, approval of frozen change payloads and shared billing proposal builders are done. The regular record editor and the billing preview still use the old calculation, and tutoring categories that can be either group or individual need a schema decision. Known gaps are pinned down by xfail tests. docs/Status.md tracks the current state.

Stack

  • Python 3.12 (the Docker image), Django 5 and Django REST Framework
  • PostgreSQL 16
  • Server-rendered Django templates with JavaScript where needed
  • pytest and pytest-django; pytest-playwright for a small browser smoke suite
  • Optional Access import through pyodbc and the Windows ACE ODBC driver

Dependencies are listed with version ranges in backend/requirements.txt.

Running it locally with Docker

Use an empty development database. The Compose file uses fixed container and volume names, so make sure it won't pick up another installation's volume.

cp .env.example .env

(Copy-Item .env.example .env in PowerShell.) Set DJANGO_SECRET_KEY and POSTGRES_PASSWORD to random values; both are required, also in development. You can generate them with:

python -c "import secrets; print(secrets.token_urlsafe(48))"

The template sets DJANGO_DEBUG=True for local work; without it, debug mode is off. Adjust the allowed hosts and origins to your environment.

docker compose up --build
docker compose exec web python manage.py createsuperuser

The web container waits for PostgreSQL, runs the migrations automatically and starts Django's development server. Then open http://localhost:8000/admin/ to create accounts and assign roles. Django's is_superuser flag and the app's SUPERADMIN role are separate things. No sample accounts or passwords are included.

The Compose setup publishes its ports on the host and mounts the source folder into the container. It is meant for development, not as a production deployment.

Running it without Docker

Create a virtual environment, install the requirements, point .env at your own PostgreSQL database and run:

python -m venv .venv
# activate it: .venv\Scripts\Activate.ps1 (PowerShell) or . .venv/bin/activate
python -m pip install -r backend/requirements.txt
python backend/manage.py check
python backend/manage.py migrate
python backend/manage.py createsuperuser
python backend/manage.py runserver 127.0.0.1:8000

backend/config/settings.py reads only the .env in the repository root, and variables already set in the environment win. The Access import is optional: it needs ACCESS_BASE_DIR and ACCESS_CONN_STRING_TEMPLATE from .env.example and should only run against a throwaway database; see the import documentation. Access files, import reports and exports are not part of the repository.

Tests

With a dedicated test database:

python backend/manage.py check
python backend/manage.py makemigrations --check --dry-run
pytest -m "not browser" --reuse-db

The browser smoke tests run separately, and not at the same time as the backend tests:

python -m playwright install chromium
pytest -m browser backend/tests/browser --browser chromium --reuse-db

The xfail tests describe the known PRICELIST v2 gaps. Coverage and limits are listed in the QA matrix and the browser QA protocol.

Documentation

Most design notes are in Russian.

How it's built

KindEltern Web is developed by Dr. Konstantin S. Shakun with AI coding agents. Claude Code works as architect and reviewer: it studies the code, discusses the approach with me and then writes small numbered implementation prompts, one change each, which a coding agent carries out. I decide what gets built, approve each plan and accept or reject the result. CLAUDE.md describes this workflow and docs/PROMPTS_OVERVIEW.md lists the prompt chain.

License

The code is available under the MIT License. The legacy VBA modules in legacy_VBA/ are not: they belong to Kinder- und Elternzentrum Kolibri e.V. and may only be reused with its permission (legacy_VBA/LICENSE).

About

KindEltern Web: Django and PostgreSQL CRM that replaces Excel/VBA and Access at an education centre. Family records, monthly fees and approval workflows; in development.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages