diff --git a/Development.md b/Development.md index c4889a17debe1aceb1a2c5758aceb662804b48f1..8264597b921bafdee6f2c03262d7489e8d953884 100644 --- a/Development.md +++ b/Development.md @@ -51,7 +51,7 @@ Um eine andere Demo Datei zu laden kann die Umgebungsvariable `DJANGO_LOAD_FIXTU - Mac: `brew install python3 postgresql gettext` bzw. https://postgresapp.com/ - Windows: [latest stable Python 3 release](https://www.python.org/downloads/windows/) und [PostgreSQL Installer](https://www.postgresql.org/download/windows/) und [gettext binaries](https://mlocati.github.io/articles/gettext-iconv-windows.html) - Python Paketmanager: `pdm`: - Kann mit OS Installationsmitteln oder mit `pip install pdm` installiert werden. + Kann mit OS Installationsmitteln, mit `pip install pdm` oder `pipx install pdm` installiert werden. 1. Klone dieses Repository an beliebigen Ort. 1. Erstelle die virtuelle Umgebung mit `pdm info` 1. Installiere die python dependencies mit `pdm install` @@ -67,8 +67,9 @@ SESSION_COOKIE_SECURE = False SESSION_COOKIE_DOMAIN = None IS_API = True IS_FRONTEND = True +STORAGE_TYPE = 'local' EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' # "send" emails as console output -SELECTED_CONFERENCE_ID = '40ba6cda-1970-409f-81ef-efb87ef09d95' # change this to the id of your conference you want to display in frontend (matches the one from rc3_2020.json) +SELECTED_CONFERENCE_ID = '40ba6cda-1970-409f-81ef-efb87ef09d95' # change this to the id of your conference you want to display in frontend (matches the one from rc3_2021.json) METRICS_SERVER_IPS = ['127.0.0.1'] # Change this if you want to test the Prometheus / Grafana metrics endpoint (http://127.0.0.1:8000/metrics/) DATABASES = { @@ -93,7 +94,7 @@ DATABASES = { 1. Aktiviere das virtual env `pdm venv activate` 2. Wende ggf. vorhandene DB-Migrations an (wenn du gerade aus dem Git geupdatet hast): `pdm manage migrate` 3. Stelle sicher dass alle Translations aktuell sind: `pdm manage compilemessages` -4. Lasse alle staticfiles einsammeln: `pdm manage collectstatic` +4. Lasse alle staticfiles einsammeln: `pdm manage collectstatic --noinput` 5. Starte den Dev-Server: `pdm manage runserver` 6. Besuche die lokale Instanz: [Admin-Seite](http://localhost:8000/c3admin/), [API](http://localhost:8000/api/) und [plainui-Frontend](http://localhost:8000/) @@ -124,7 +125,7 @@ Mittels diesem werden die `requirements.txt` und die `requirements.dev.txt` erze #### Installation der aktuellen Abhängigkeiten Um die aktuellen python Abhängigkeiten zu installieren kann das Kommando `pdm install` verwendet werden. -Mit dem Kommando `pdm sync --clean` kann sichergestellt werden, dass genau die Versionen aus dem pdm lock file installiert werden. +Mit dem Kommando `pdm sync --clean` kann sichergestellt werden, dass genau die Versionen aus dem pdm lock file installiert werden. _Achtung_: **Nicht in der Lock Datei enthaltene python Pakete werden deinstalliert!** #### Hinzufügen von neuen Abhängigkeiten @@ -132,7 +133,7 @@ _Achtung_: **Nicht in der Lock Datei enthaltene python Pakete werden deinstallie Um neue Abhängigkeiten hinzuzufügen kann das Kommando `pdm add` verwendet werden. Mit dem Parameter `--dev` kann eine Abhängigkeit als Entwicklungs-Abhängigkeit deklariert werden. Diese wird dann in den Produktivinstanzen nicht installiert. Anschließend müssen die `requirements.txt` und `requirements.dev.txt` angepasst werden. -Wenn `pre-commit` verwendet wird, passiert dies automatisch beim commit. +Wenn `pre-commit` verwendet wird, passiert dies automatisch beim commit. Alternativ können die folgenden Kommandos verwendet werden ```bash diff --git a/README.md b/README.md index 2aef8db2d832d38824dce39b1aea70f4ec86e5fb..e4209e3b4eeac61ff5e90968eae83577baeeb1b1 100644 --- a/README.md +++ b/README.md @@ -31,11 +31,11 @@ als PDF: [Grobes Datenmodell](docs/Grobes Datenmodell.pdf) und [automatisch expo ## REST API -Am Beispiel der Konferenz-Slug "camp23", grundsätzlich sind alle hier aufgeführten Endpoints per GET abrufbar (Restriktionen bei nicht-öffentlichen Events, etc. sind möglich). +Grundsätzlich sind alle hier aufgeführten Endpoints per GET abrufbar (Restriktionen bei nicht-öffentlichen Events, etc. sind möglich). Manche Endpunkte sind zusätzlich "schreibbar" und können zur Anlage bzw. Bearbeitung der jeweiligen Daten genutzt werden. Testinstanz: <https://hub.test.c3voc.de/api/> / <https://staging.hub.c3events.de/api/> \ -Prodinstanz: <https://api.events.ccc.de/congress/2023/> +Prodinstanz: <https://api.events.ccc.de/congress/2024/> | Kategorie | Endpunkt | GET | POST | PUT | DEL | Beschreibung | | ---------- | ---------------------------------------- | --- | ---- | --- | --- | ----------------------------------------------------- | @@ -63,3 +63,7 @@ Prodinstanz: <https://api.events.ccc.de/congress/2023/> Per POST werden neue Einträge angelegt, per PUT bestehende verändert. Details zu den einzelnen Endpunkten folgen in Kürze™. + +## Development + +see [Development.md](./Development.md)