fristy/README.md

80 lines
1.5 KiB
Markdown

# Fristy
Eine moderne, modulare App zur Verwaltung aller persönlichen Verträge.
## ✨ Features
- 📱 **Vertrags-Management**: Alle Verträge an einem Ort
- 🔔 **Kündigungs-Erinnerungen**: Nie wieder eine Frist verpassen
- 💰 **Kosten-Übersicht**: Monatliche und jährliche Ausgaben im Blick
- 📄 **Dokumente**: PDF-Uploads für Verträge
- 🔐 **Sicher**: End-to-End verschlüsselt
- 🎨 **Modern**: Schönes, intuitives Design
- 🔄 **Cross-Platform**: iOS & Android
## 🚀 Quick Start
```bash
# Dependencies installieren
npm install
# iOS
npm run ios
# Android
npm run android
```
Siehe [GETTING_STARTED.md](./GETTING_STARTED.md) für detaillierte Setup-Anleitung.
## 📋 Projekt Status
**Version**: 0.0.1 (Early Development)
**Aktuelle Phase**: Grundstruktur & Setup
**Nächste Schritte**:
- [ ] Auth Screens implementieren
- [ ] Contract CRUD Screens
- [ ] Dashboard mit Statistiken
- [ ] Push-Benachrichtigungen
## 🏗️ Architektur
- **Framework**: React Native
- **State**: Zustand
- **Backend**: Supabase
- **Navigation**: React Navigation
- **Language**: TypeScript
Siehe [ARCHITECTURE.md](./ARCHITECTURE.md) für detaillierte Architektur-Dokumentation.
## 📱 Unterstützte Plattformen
- ✅ iOS 13+
- ✅ Android 8.0+
## 🤝 Entwicklung
```bash
# Development Server starten
npm start
# Type Checking
npm run type-check
# Linting
npm run lint
# Tests
npm test
```
## 📄 Lizenz
Proprietary - Alle Rechte vorbehalten
## 👨‍💻 Autor
Fristy Team