From 152dfea074db47d684f44fbdbfaa58ed51e0c0d0 Mon Sep 17 00:00:00 2001
From: Sebastian Frank <sebastian@webmakers.de>
Date: Mon, 13 Mar 2023 13:15:48 +0000
Subject: [PATCH] readme

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0000a7d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# Tibi Docs und Demo Projekt
+
+Diese Repo enthält die Dokumentation zum TibiCMS und eine Demo-Projekt welches die Dokumentation begleitet.  
+
+Das Demo-Projekt kann als Vorlage für neue Tibi-Projekte verwendet werden.
+
+## neues Projekt - Checkliste
+
+- [x] neues Projekt im gitbase.de anlegen (cms/tibi-docs) als Vorlage verwenden
+- [ ] klonen
+- [ ] bereinigen
+
+```sh
+git filter-branch -f --index-filter 'git rm -rf --cached --ignore-unmatch .yarn/cache' HEAD
+git filter-branch -f --index-filter 'git rm -rf --cached --ignore-unmatch docs' HEAD
+git push --force
+```
+
+- [ ] anpassen
+
+  - `.env`
+  - `docker-compose-local.yml` -> `name:`
+  - `api/...`
+
+- [ ] upgraden
+
+```sh
+make yarn-upgrade
+make docker-pull
+```
+
+- [ ] los programmieren
+
+```sh
+make docker-start
+```
+
+- [ ] Projekt in Tibi bekannt machen:
+  - <https://PROJEKTNAME-tibiadmin.code.testversion.online>
+  - Pfad der API-Konfig: `/data/api/config.yml`
+- [ ] Website im Browser ansehen:
+  - <https://PROJEKTNAME.code.testversion.online>
+- [ ] Testmails checken:
+  - <https://PROJEKTNAME-maildev.testversion.online>
+
+- [ ] deploy
+  1. [ ] Subdomain im basispanel anlegen auf `../frontend/`
+  2. [ ] rsync-Account in basispanel anlegen auf `htdocs/`
+  3. [ ] Passwort in Secrets eintragen: <https://drone.gitbase.de>
+  4. [ ] `.drone.yml` anpassen
+  5. [ ] pushen