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