[add] readme
This commit is contained in:
parent
f48ea6b9cd
commit
61688ae614
1 changed files with 38 additions and 0 deletions
38
readme.md
Normal file
38
readme.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# Zeitbild | Web-Frontend
|
||||
|
||||
## Beschreibung
|
||||
|
||||
- Web-Frontend für [`zeitbild`](https://forgejo.linke.sx/zeitbild/backend)
|
||||
|
||||
|
||||
## Erstellung
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- GNU Make
|
||||
|
||||
|
||||
### Anweisungen
|
||||
|
||||
- siehe `tools/build -h`
|
||||
|
||||
|
||||
## Test
|
||||
|
||||
(noch keine vorhanden)
|
||||
|
||||
|
||||
## Betrieb
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- wahlweise einen Python-Interpreter oder ein vollwertiger Web-Server (nginx, Apache, lighttpd, …)
|
||||
- zum Aufruf wird ein halbwegs aktueller Web-Browser vorausgesetzt
|
||||
|
||||
|
||||
### Anweisungen
|
||||
|
||||
- `conf.json` im build-Verzeichnis anlegen
|
||||
- für Entwicklung und Test kann der Python-Webserver genutzt werden: ins build-Verzeichnis wechseln und `python3 -m http.server [port]` ausführen
|
||||
- für Produktiv-Umgebungen sollte eine vhost-Konfiguration für den Web-Server angelegt werden
|
||||
|
Loading…
Add table
Reference in a new issue