docs: README.md and docs
This commit is contained in:
Ismail Ali
140
README.md
140
README.md
@@ -1,50 +1,118 @@
|
||||
# Welcome to your Expo app 👋
|
||||
# 📱 Heval Light – Personal Assistant App
|
||||
|
||||
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
|
||||
**Heval Light** ist eine persönliche Assistenten-App für iOS/Android, entwickelt mit **React Native + Expo**.
|
||||
Die App soll langfristig ein smarter Begleiter für Studierende, Arbeitnehmer und Privatpersonen werden – mit **Kalender-, Erinnerungs- und KI-Funktionen**.
|
||||
|
||||
## Get started
|
||||
---
|
||||
|
||||
1. Install dependencies
|
||||
## ✨ Features (aktueller Stand)
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
✅ **Benutzerregistrierung & Login**
|
||||
|
||||
2. Start the app
|
||||
- Vorname, Nachname, E-Mail, Passwort
|
||||
- Speicherung in **SQLite**
|
||||
- **Biometrische Anmeldung** via Face ID/Touch ID
|
||||
|
||||
```bash
|
||||
npx expo start
|
||||
```
|
||||
✅ **Kalender & Erinnerungen**
|
||||
|
||||
In the output, you'll find options to open the app in a
|
||||
- Zugriff auf **iOS Kalender/Erinnerungen** via `expo-calendar`
|
||||
- Speicherung von Events in **lokaler SQLite-Datenbank**
|
||||
- **Modal-Formular** für manuelles Hinzufügen von Terminen
|
||||
|
||||
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
|
||||
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
|
||||
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
|
||||
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
|
||||
✅ **Lokale Speicherung & Sessions**
|
||||
|
||||
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
|
||||
- Benutzer-Session wird sicher in **AsyncStorage** gehalten
|
||||
- Passwort & Benutzerdaten lokal in SQLite gespeichert
|
||||
|
||||
## Get a fresh project
|
||||
✅ **Zukunftsorientierte Funktionen (geplant)**
|
||||
|
||||
When you're ready, run:
|
||||
- **GPS-Standort** automatisch übernehmen (Wohnort, Arbeitsplatz/Uni)
|
||||
- **Sprachbasierte Eingabe** (Speech-to-Text für Erinnerungen)
|
||||
- **KI-Assistent (ChatGPT)** zur Organisation
|
||||
- **Push-Notifications** für Erinnerungen
|
||||
|
||||
---
|
||||
|
||||
## 🗺️ Roadmap
|
||||
|
||||
- [ ] **Registrierung erweitern**: Wohnort/Arbeitsort per GPS automatisch erkennen
|
||||
- [ ] **Speech-to-Text** für neue Erinnerungen/Termine
|
||||
- [ ] **Push-Notifications** für wichtige Events
|
||||
- [ ] **AI-Integration** (ChatGPT für intelligente Terminplanung)
|
||||
- [ ] **Mehrsprachigkeit** (Deutsch/Englisch)
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Technologie-Stack
|
||||
|
||||
- **React Native + Expo (Managed Workflow)**
|
||||
- **SQLite** für lokale Benutzer- & Eventdaten
|
||||
- **AsyncStorage** für Sitzungen
|
||||
- **expo-local-authentication** für Face ID/Touch ID
|
||||
- **expo-calendar** für Kalender- und Erinnerungszugriff
|
||||
- **expo-location** (geplant) für GPS-Standort
|
||||
- **react-native-voice** (geplant) für Spracheingabe
|
||||
|
||||
---
|
||||
|
||||
## 📂 Projektstruktur
|
||||
|
||||
app/
|
||||
├─ index.tsx # AuthScreen: Registrierung, Login, FaceID
|
||||
├─ calendar.tsx # Kalender & Erinnerungen, SQLite-Speicherung
|
||||
├─ (geplant) reminders.tsx # Sprachbasierte Erinnerungen
|
||||
└─ ...
|
||||
|
||||
yaml
|
||||
Copy
|
||||
Edit
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Installation & Start
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- Node.js (>= 18)
|
||||
- Expo CLI
|
||||
- Git
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
npm run reset-project
|
||||
# Repository klonen
|
||||
git clone <repo-url>
|
||||
cd heval-light
|
||||
|
||||
# Abhängigkeiten installieren
|
||||
npm install
|
||||
|
||||
# App starten
|
||||
npx expo start
|
||||
Auf iOS: Expo Go App installieren und QR-Code scannen
|
||||
|
||||
Auf Android: ebenfalls Expo Go oder Emulator verwenden
|
||||
|
||||
🔐 Sicherheit
|
||||
Benutzer- und Kalenderdaten bleiben lokal auf dem Gerät
|
||||
|
||||
Kein externer Server nötig
|
||||
|
||||
Geplant: Verschlüsselte Speicherung (SecureStore)
|
||||
|
||||
🧭 Ziel der App
|
||||
Heval Light soll zu einem intelligenten Assistenten werden, der dir hilft bei:
|
||||
|
||||
Kalender- & Erinnerungsverwaltung
|
||||
|
||||
Standortbasierten Aufgaben (Wohnort, Arbeitsplatz, Uni)
|
||||
|
||||
Sprach- und KI-gestützter Organisation
|
||||
|
||||
🤝 Mitwirken
|
||||
Dieses Projekt ist noch in der aktiven Entwicklung.
|
||||
Ideen, Feedback oder Pull Requests sind willkommen!
|
||||
|
||||
📜 Lizenz
|
||||
MIT License – frei nutzbar für private & kommerzielle Zwecke.
|
||||
```
|
||||
|
||||
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
|
||||
|
||||
## Learn more
|
||||
|
||||
To learn more about developing your project with Expo, look at the following resources:
|
||||
|
||||
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
|
||||
- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
|
||||
|
||||
## Join the community
|
||||
|
||||
Join our community of developers creating universal apps.
|
||||
|
||||
- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
|
||||
- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.
|
||||
|
||||
Reference in New Issue
Block a user