Tronax
a00db14cba
- NetworkMonitor: ConnectivityState Flow using ConnectivityManager.NetworkCallback
- ListsScreen & ViewModel: live offline indicator banner when disconnected
- Documentation:
- docs/ARCHITECTURE.md: system design & tech stack overview
- docs/SYNC.md: HLC timestamping, op_log outbox & LWW projection specification
- docs/API.md: REST API endpoint specification
- README.md: quickstart guide for backend, docker compose & Android app
- Verification: backend & android test suites 100% green ✅
83 lines
2.7 KiB
Markdown
83 lines
2.7 KiB
Markdown
# Mitbringsl 🛒
|
||
|
||
> **Local-First Einkaufslisten-App (Bring-Alternative, werbefrei & datensparsam).**
|
||
|
||
Mitbringsl ist eine moderne, schnelle und werbefreie Einkaufslisten-App mit **Local-First Synchronization**. Die App funktioniert vollständig offline und synchronisiert Änderungen automatisch, sobald eine Verbindung besteht — ohne Datenverlust oder Konflikte.
|
||
|
||
---
|
||
|
||
## 🌟 Highlights & Features
|
||
|
||
- 📱 **Android App**: Kotlin 2.x, Jetpack Compose Material 3, Room, Hilt, WorkManager.
|
||
- ⚡ **Local-First Sync Engine**: Hybrid Logical Clock (HLC), append-only `op_log`, Last-Write-Wins (LWW) Projektionen, Idempotente Push/Pull-Algorithmen.
|
||
- 🔐 **Datenschutz & Auth**: Argon2id Passwort-Hashing, opaque Session-Tokens, OIDC-Unterstützung (Google & eigene IdPs).
|
||
- 🚀 **Go Backend**: Stdlib `net/http` Routing (Go 1.26), PostgreSQL 16 (`pgxpool`), `pg_trgm` Fuzzy Autocomplete.
|
||
- 🛡️ **Deployment**: Multi-Stage Docker Container, Caddy Reverse Proxy mit automatischem HTTPS / Standalone & Behind-Proxy Modi.
|
||
|
||
---
|
||
|
||
## 🏗️ Repository-Struktur
|
||
|
||
```
|
||
mitbringsl/
|
||
├── backend/ # Go REST API Backend
|
||
│ ├── cmd/ # Server & Migrate Binaries
|
||
│ ├── internal/ # Auth, Sync (HLC), Store (pgx), HTTP API
|
||
│ ├── migrations/ # SQL Migrationen (iofs-embedded)
|
||
│ └── Dockerfile # Multi-Stage Build (golang:1.26 -> distroless)
|
||
├── android/ # Android Kotlin + Compose App
|
||
│ ├── app/src/ # Room DB, Retrofit API, WorkManager, Hilt, Compose UI
|
||
│ └── build.gradle.kts
|
||
├── deploy/ # Docker Compose & Caddy Setup
|
||
│ ├── docker-compose.yml
|
||
│ ├── Caddyfile / Caddyfile.behind-proxy
|
||
│ └── .env.example
|
||
└── docs/ # Architektur- & Protokoll-Dokumentation
|
||
├── ARCHITECTURE.md # Gesamtarchitektur & Systemdesign
|
||
├── SYNC.md # Sync-Protokoll & HLC-Spezifikation
|
||
└── API.md # REST API Dokumentation
|
||
```
|
||
|
||
---
|
||
|
||
## 🚀 Quickstart: Backend & Stack lokal starten
|
||
|
||
### 1. Backend lokal bauen & testen
|
||
```bash
|
||
cd backend
|
||
go build ./...
|
||
go vet ./...
|
||
go test ./...
|
||
```
|
||
|
||
### 2. Stack per Docker Compose starten
|
||
```bash
|
||
cd deploy
|
||
cp .env.example .env
|
||
# Passwörter in .env anpassen
|
||
docker compose up -d --build
|
||
```
|
||
|
||
---
|
||
|
||
## 📱 Android App bauen
|
||
|
||
```bash
|
||
cd android
|
||
./gradlew assembleDebug
|
||
./gradlew test
|
||
```
|
||
|
||
---
|
||
|
||
## 📖 Dokumentation
|
||
|
||
- [ARCHITECTURE.md](docs/ARCHITECTURE.md) – Architektur & Systemdesign
|
||
- [SYNC.md](docs/SYNC.md) – Synchronisationsprotokoll & HLC-Spezifikation
|
||
- [API.md](docs/API.md) – REST API Endpoint-Referenz
|
||
- [AGENTS.md](AGENTS.md) – Projektstand & Architekturentscheidungen für KI-Agenten
|
||
|
||
---
|
||
|
||
## 📄 Lizenz
|
||
MIT License
|