Kairo-Jinkendo/README.md
Lars ea445a9263
Some checks failed
Deploy Production / deploy (push) Failing after 0s
Deploy Development / deploy (push) Failing after 0s
Test Suite / pytest-backend (push) Failing after 5m1s
Test Suite / lint-backend (push) Failing after 0s
Test Suite / build-frontend (push) Failing after 3s
Test Suite / k6 /health Baseline (push) Failing after 3m4s
Test Suite / playwright-tests (push) Failing after 3m59s
Merge remote main: README-Konflikt aufgeloest, Produktbeschreibung uebernommen.
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-04 18:16:28 +02:00

64 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Kairo Jinkendo (回廊)
**Programmmanager für alles im Leben** — Produktfamilie Jinkendo (人拳道), Schwesterprodukt zu Shinkan und Mitai.
> Infrastruktur-Setup: Deployment, Docker und Gitea Actions sind vorbereitet.
> Anwendungscode (Backend/Frontend) folgt in einem separaten Schritt.
## Deployment-Übersicht
| Umgebung | Branch | Server-Pfad | Host-Ports (UI/API) | Domain |
|----------|--------|-------------|---------------------|--------|
| **Development** | `develop` | `/home/lars/docker/kairo-dev` | 3097 / 8097 | https://dev.kairo.jinkendo.de |
| **Production** | `main` | `/home/lars/docker/kairo` | 3004 / 8004 | https://kairo.jinkendo.de |
Auto-Deploy via Gitea Actions auf dem Raspberry Pi (gleicher Runner wie Shinkan/Mitai).
**Gitea:** http://192.168.2.144:3000/Lars/Kairo-Jinkendo
## Tech-Stack (geplant)
- **Frontend:** React 18 + Vite + PWA
- **Backend:** FastAPI (Python 3.12)
- **Datenbank:** PostgreSQL 16
- **Container:** Docker + Docker Compose
## Lokales Setup (wenn App-Code vorhanden)
```bash
git clone http://192.168.2.144:3000/Lars/Kairo-Jinkendo.git
cd Kairo-Jinkendo
cp .env.example .env
# .env anpassen
# Development
docker compose -f docker-compose.dev-env.yml up --build
# Production (lokal)
docker compose up --build
```
Frontend (Dev): http://localhost:3097
Backend (Dev): http://localhost:8097
## Server-Einrichtung
Siehe [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) für Verzeichnisse, `.env`-Dateien und Reverse-Proxy-Hinweise auf dem Pi.
## Git-Workflow
```
develop → Auto-Deploy → kairo-dev (Dev)
main → Auto-Deploy → kairo (Prod)
```
## Dokumentation
- **Deployment:** [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)
- **Entwickler-Kontext:** [CLAUDE.md](CLAUDE.md)
- **Schwesterprojekt (Referenz):** [shinkan-jinkendo](http://192.168.2.144:3000/Lars/shinkan-jinkendo)
## Lizenz
Proprietary Lars Stommer