Skip to content
Snippets Groups Projects
Select Git revision
2 results Searching

Development.md

Blame
    • Forked from hub / hub
    Loading
    Lucas Brandstaetter's avatar
    Update development environment and docs
    Roang authored 
    * Split Readme into Readme and Development.md
* Update Development.md with more detailed instructions
* Remove outdated devcontainer.json and docker-compose.yml
* Ignore all .envrc files, each user will have a different setup
  (e.g., database, etc.)
    b47f3760
    History
    Lucas Brandstaetter's avatar b47f3760
    History
    Development.md 12.51 KiB

    Lokale Entwicklung

    Dieses Projekt basiert auf Python 3.13+ und Django 5.1+.

    Initiale Einrichtung

    Lokales Docker development image

    Das Docker development image vereinfacht die initiale Einrichtung und sperrt alle Abhängigkeiten und Prozesse in einen Entwicklungscontainer. Alternativ ist auch eine manuelle Einrichtung möglich.

    1. Docker und Docker Compose installieren. Unter Windows getestet mit WSL 2.
    2. Klonen dieses Repositories an beliebigen Ort.
    3. Image erzeugen: docker compose build
      • Für schnellere Builds kann buildkit verwendet werden: 
        export DOCKER_BUILDKIT=1
      • Die Standardpasswöter für PostgreSQL und Hub Benutzer sind in der docker-compose.yml Datei festgelegt und können per Umgebungsvariable angepasst werden.
    4. Container erzeugen: docker compose up -d hub
      • Beim Start mittels docker compose wird kein HUB Admin Benutzer angelegt um ein ungewolltes anlegen von diesen Benutzern in der Produktivumgebung vorzubeugen. Falls der admin Benutzer angelegt werden soll muss die Umgebungsvariable DJANGO_CREATE_ADMIN_PASSWORD für den Container gesetzt werden.
    5. Optional: Import von Demo-Daten: docker compose exec -it hub python manage.py loaddata ./core/fixtures/anhalter.json

    Debug Zugriff

    Um auf einen Docker Container mit dem root bentuzer zuzugreifen kann das folgende Kommando verwendet werden: docker compose exec -u root hub /bin/bash

    Docker Einstellungen in der Entwicklungsumgebung

    Um die Einstellungen der Instanz anzupassen kann eine dev.env Datei im Root-Verzeichnis angelegt werden.

    Impressum - Datenschutzerklärung