Skip to content

Commit 6a1f218

Browse files
committed
feat: update documentation with an overview of AsphaltGhost, quickstart setup, and detailed feature descriptions for community feed, spot map, moderation, and push notifications
1 parent 4b67add commit 6a1f218

6 files changed

Lines changed: 54 additions & 31 deletions

File tree

docs/features/feed.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Feature: Community-Feed
2+
3+
Chronologischer Feed, Post erstellen (Text + Fotos), Like und Kommentar. Post-Detail als Modal. Bild-Safety bei Uploads. Routen: feed.tsx, create-post.tsx, post/[id].tsx. Siehe DATABASE.md und ARCHITECTURE.md.

docs/features/map.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Feature: Spot-Map
2+
3+
Karte mit approved Spots, react-native-maps und Google Maps. Optional Custom Dark Style. Ghost-Marker je Spot-Typ. Filter und Suchfeld. Spot-Detail oeffnet als Modal. Siehe ARCHITECTURE.md und DESIGN.md im Repo.

docs/features/moderation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Feature: Moderation und Admin
2+
3+
Moderatoren: Pending Spots freigeben/ablehnen; Reports (Spot/Post) bearbeiten; Push bei neuer Meldung oder neuem Spot-Review. Admins: Moderatoren verwalten; User loeschen. Tabellen: moderators, admins, reports. Routen: moderation.tsx, admin.tsx. Siehe DATABASE.md und DECISIONS.md.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Feature: Push-Benachrichtigungen
2+
3+
Zwei Arten: (1) Moderator-Push per Edge Function notify-moderators bei neuer Meldung oder Spot-Review; Tokens in moderation_push_tokens. (2) Taegliche lokale Erinnerung (max. 1/Tag), Toggle in Einstellungen. In Expo Go wird Push-Logik uebersprungen. Siehe DATABASE.md, SETUP.md, DECISIONS.md.

docs/intro.md

Lines changed: 19 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,26 @@
1-
---
2-
sidebar_position: 1
3-
slug: /
4-
---
1+
# AsphaltGhost – Ueberblick
52

6-
# AsphaltGhost Documentation
3+
AsphaltGhost ist eine mobile Community-App fuer die Auto-Szene: Drift-Spots und Tuning-Treffen finden, einreichen und bewerten, plus Community-Feed.
74

8-
Welcome to the AsphaltGhost documentation site.
5+
## Tech Stack
96

10-
## Getting Started (5 Minuten)
7+
- **App:** Expo SDK 54, Expo Router v6, TypeScript, React Query, Zustand
8+
- **Karte:** react-native-maps mit Google Maps (PROVIDER_GOOGLE)
9+
- **Backend:** Supabase (Auth, PostgreSQL, Storage, Edge Functions)
10+
- **Push:** Expo Notifications (Moderator-Benachrichtigungen, taegliche Erinnerung optional)
1111

12-
1. Clone:
13-
- `git clone --recurse-submodules git@github.com:AsphaltGhost/base-app.git`
14-
2. Install:
15-
- `cd base-app`
16-
- `npm install`
17-
3. Configure env:
18-
- `.env.example` zu `.env` kopieren
19-
- `EXPO_PUBLIC_SUPABASE_URL`, `EXPO_PUBLIC_SUPABASE_ANON_KEY`, `EXPO_PUBLIC_MAPBOX_ACCESS_TOKEN` setzen
20-
4. Build Android Dev Client (wegen Mapbox):
21-
- `npx expo run:android`
22-
5. Start App:
23-
- `npx expo start --dev-client`
12+
## Kernfunktionen (MVP)
2413

25-
## Overview
14+
- **Auth:** Login mit E-Mail oder Username; Profil mit optionalem Vor-/Nachnamen
15+
- **Spot-Map:** Karte mit approved Spots, Filter, Ghost-Marker, Spot-Detail als Modal
16+
- **Spot einreichen:** Adresssuche + Kartenauswahl; KI-Analyse; Bild-Safety
17+
- **Bewertung und Kommentare:** 1-5 Sterne, Kommentar; Bewertung bearbeiten/loeschen
18+
- **Feed:** Chronologischer Feed, Post erstellen, Like/Kommentar, Post-Detail
19+
- **Moderation:** Pending Spots und Reports; Moderatoren-Push
20+
- **Admin:** Moderatoren zuweisen; User loeschen
21+
- **Einstellungen:** Map-Style, Haptik, Push-Erinnerung; Profil/Account; Account loeschen (2-Schritt)
2622

27-
This site centralizes setup, architecture, database, design, deployment, and MVP handoff documentation for `base-app`.
23+
## Weitere Docs
2824

29-
## Documentation Index
30-
31-
- [Setup](./setup)
32-
- [Architecture](./architecture)
33-
- [Database](./database)
34-
- [Design](./design)
35-
- [Deployment](./deployment)
36-
- [Decisions (ADR Light)](./decisions)
37-
- [MVP Acceptance Checklist](./mvp-acceptance)
38-
- [Troubleshooting](./troubleshooting)
25+
- Repo `docs/`: ARCHITECTURE, DATABASE, SETUP, DEPLOYMENT, DECISIONS, DESIGN
26+
- Plan: `asphaltghost-mvp-plan.md`

docs/setup-quickstart.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Setup – Kurzfassung
2+
3+
Schneller Einstieg für Entwickler. Ausführlich: `docs/SETUP.md` im Repo.
4+
5+
## Voraussetzungen
6+
7+
- Node 20, npm, JDK 17, Android Studio (für Android Build)
8+
- Supabase-Projekt, Google Maps API Key
9+
10+
## Schritte
11+
12+
1. **Repo klonen:** `git clone --recurse-submodules <repo-url>``cd base-app`
13+
2. **Install:** `npm install`
14+
3. **Umgebung:** `.env` mit `EXPO_PUBLIC_SUPABASE_URL`, `EXPO_PUBLIC_SUPABASE_ANON_KEY`; Google Maps Key in `app.json`
15+
4. **Supabase:** Alle Migrationen von `0001` bis `0020` im SQL Editor ausführen (siehe `docs/DATABASE.md`)
16+
5. **Edge Functions:** `supabase functions deploy analyze-spot` und `supabase functions deploy notify-moderators`; Secret `OPENAI_API_KEY` setzen
17+
6. **Dev Build:** `npx expo run:android` (oder iOS), danach `npx expo start --dev-client`
18+
19+
## Wichtige Hinweise
20+
21+
- **Karte & Push** benötigen einen Development Build (nicht Expo Go).
22+
- **Auth** nutzt AsyncStorage; Redirect in Supabase auf `asphaltghost://login` setzen.
23+
- **Docs (Docusaurus):** Bei Bedarf `cd docs-site && npm install && npm start`.

0 commit comments

Comments
 (0)