docs: add initial docs for commits, deployment, env variables and setup
This commit is contained in:
48
docs/SETUP.md
Normal file
48
docs/SETUP.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# ⚙️ Setup-Anleitung
|
||||
|
||||
Diese Datei beschreibt, wie du das Projekt lokal einrichtest und startest.
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Voraussetzungen
|
||||
|
||||
- Docker & Docker Compose
|
||||
- Python 3 (für Ansible, optional pipx)
|
||||
- Optional: Ansible (für Server-Setup)
|
||||
- Optional: PhpStorm oder VS Code
|
||||
|
||||
---
|
||||
|
||||
## 📦 Projektstruktur
|
||||
|
||||
```
|
||||
.
|
||||
├── app/ # PHP/NGINX-Anwendung
|
||||
├── ansible/ # Setup- und Deployment-Playbooks
|
||||
├── docker-compose.yml
|
||||
├── .env # Lokale Konfiguration (nicht versioniert)
|
||||
├── Makefile # Komfortbefehle
|
||||
└── docs/ # Dokumentation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ▶️ Lokaler Start
|
||||
|
||||
```bash
|
||||
# Container starten
|
||||
docker compose up --build
|
||||
|
||||
# Alternativ mit Makefile
|
||||
make deploy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Lokale Tests
|
||||
|
||||
- `http://localhost:8080` → NGINX + PHP
|
||||
- Logs anzeigen: `docker compose logs -f`
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user