39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# RIOTZ
|
|
|
|
Underground social/music app starter built with Flutter, Supabase, Riverpod, and `go_router`.
|
|
|
|
## Run
|
|
|
|
```bash
|
|
flutter pub get
|
|
flutter run \
|
|
--dart-define=SUPABASE_URL=https://YOUR_PROJECT_ID.supabase.co \
|
|
--dart-define=SUPABASE_ANON_KEY=YOUR_SUPABASE_ANON_KEY
|
|
```
|
|
|
|
## Architecture
|
|
|
|
```text
|
|
lib/
|
|
app/
|
|
app.dart # MaterialApp wiring and global shell
|
|
core/
|
|
config/supabase_config.dart # Supabase bootstrap
|
|
router/ # Route constants + go_router config
|
|
supabase/supabase_providers.dart # Base Supabase Riverpod providers
|
|
theme/ # RIOTZ dark palette and theme
|
|
features/
|
|
auth/presentation/providers/ # Auth state providers
|
|
splash/presentation/pages/ # Entry page
|
|
home/presentation/pages/ # Main starter page
|
|
shared/widgets/riotz_shell.dart # Reusable branded page container
|
|
```
|
|
|
|
## Notes
|
|
|
|
- `SupabaseConfig` reads credentials from `--dart-define` values.
|
|
- Use `.env.example` as a template for local values.
|
|
- Use `env.production.json.example` as a template for release `--dart-define-from-file`.
|
|
- This scaffold is clean-architecture ready and feature-module friendly.
|
|
- For production Android/iOS release setup, see `DEPLOYMENT.md`.
|