forked from ag_kommunikation/webseite
86 lines
3.2 KiB
Markdown
86 lines
3.2 KiB
Markdown
[](https://drone.wtf-eg.de/ag_kommunikation/webseite)
|
|
|
|
# Öffentliche Seite der WTF Kooperative eG
|
|
|
|
Öffentliche Website der Genossenschaft auf Basis des Static-Site-Generators [Lektor](https://www.getlektor.com/).
|
|
|
|
<a href="https://wtf-eg.de/"><img src="https://git.wtf-eg.de/ag_kommunikation/webseite/raw/branch/main/assets/images/wtf_logo.svg" width="420px" alt="WTF Logo"/></a>
|
|
|
|
Das Git Repository zur Webseite ist auf [git.wtf-eg.de/ag_kommunikation/webseite](https://git.wtf-eg.de/ag_kommunikation/webseite.git).
|
|
|
|
|
|
## Lokales entwickeln
|
|
|
|
### Vorbereitung
|
|
|
|
Installation von Lektor, siehe offizielle [Doku](https://www.getlektor.com/docs/installation/).
|
|
|
|
```
|
|
# install git requirements
|
|
sudo apt install git-lfs
|
|
|
|
# install lektor requirements
|
|
sudo apt install python3-pip imagemagick
|
|
|
|
# install lektor
|
|
pip3 install --user lektor
|
|
|
|
# clone git repo to folder wtf-webseite
|
|
git clone https://git.wtf-eg.de/ag_kommunikation/webseite.git wtf-webseite
|
|
|
|
# change to repo
|
|
cd wtf-webseite
|
|
|
|
# install lfs
|
|
git lfs install
|
|
|
|
# download all LFS files
|
|
git lfs fetch
|
|
|
|
# run lektor
|
|
lektor server
|
|
```
|
|
|
|
### Server starten
|
|
|
|
Der Server kann nun per `lektor server` gestartet werden und sollte unter http://127.0.0.1:5000/ erreichbar sein.
|
|
|
|
|
|
### Git Magie
|
|
|
|
Bevor du die Änderungen an der Webseite commitest, möchtest du dir vielleicht anschauen, welche Dateien sich geändert haben. Der Befehl ``git status`` ist hier dein Freund.
|
|
|
|
Da wir das direkte pushen auf den ``main`` Branch verbieten, möchtest du vermutlich einen neuen Branch erstellen. Das geht über ``git checkout -b <branch_name>``. Mit ``git status`` siehst du auch, auf welchem branch du bist. Den kannst du per ``git push origin <branch_name>`` dann auch auf den Webserver pushen.
|
|
Pushen kannst du, was du commitest hast. ``git commit`` Eine aussagekräftige commit-beschreibung wird gerne gesehen.
|
|
|
|
|
|
### LFS Überspringen.
|
|
|
|
Wir verwenden LFS zum Speichern von großen Dateien wie den Podcast, Bilder und so weiter. Wenn du ganz genau weißt, was du machen willst und in Kauf nimmst, dass nicht alle Elemente der Webseite bei dir lokal laden, kannst du das auch überspringen. Der Trick ist folgende Option:
|
|
```bash
|
|
export GIT_LFS_SKIP_SMUDGE=1
|
|
git clone <git_repo>
|
|
```
|
|
*(Da das Rendern der Startseite die Bilder benötigt, willst du dann im lektor direkt auf eine andere Unterseite wechseln. Die Seite [http://localhost:5000/admin/](http://localhost:5000/admin/) sollte nützlich sein!)*
|
|
|
|
## Deployment
|
|
|
|
### Per Drone
|
|
|
|
Drone testet bereits automatisch den eingecheckten Code im `main`-Branch und für Pull Requests.
|
|
Deployments finden nicht automatisch statt, sondern müssen angestoßen werden.
|
|
|
|
Wähle dazu den erfolgreichen Build, den du deployen möchtest unter https://drone.wtf-eg.de/ag_kommunikation/webseite aus.
|
|
Rechts oben findest du dann einen Knopf zum Deployment (Wolke mit Pfeil).
|
|
Als Environment kannst du _spielwiese_ oder _www_ verwenden.
|
|
|
|
### Per Hand
|
|
Das Deployment sollte für maximale Reproduzierbarkeit und Nachvollziehbarkeit immer über Drone stattfinden.
|
|
In Ausnahmesituationen kann jedoch ein manuelles Deployment nötig sein.
|
|
|
|
```bash
|
|
lektor build
|
|
lektor deploy dev # Deployment auf die Spielwiese
|
|
lektor deploy live # Deployment auf die Live-Seite
|
|
```
|