docs: replace boilerplate README with car64 project guide
This commit is contained in:
parent
e7fe347670
commit
1395a75f1b
1 changed files with 32 additions and 11 deletions
43
README.md
43
README.md
|
|
@ -1,17 +1,38 @@
|
|||
# hwhub
|
||||
# car64
|
||||
|
||||
A new Flutter project.
|
||||
car64 is a Flutter + Supabase Hot Wheels collector app with a fast scanning workflow, private photo storage, collaborative collections, and community-based catalog validation.
|
||||
|
||||
## Getting Started
|
||||
## Core Features
|
||||
|
||||
This project is a starting point for a Flutter application.
|
||||
- Lightning add flow with barcode/OCR scanning and active collection selection.
|
||||
- Global catalog (`global_cars`) + personal entries (`hotwheels`) architecture.
|
||||
- Private storage (`car-images`) with signed URL rendering for collection members.
|
||||
- In-app photo compression pipeline (target max 1080px and <500 KB uploads).
|
||||
- Collaborative garages via `collections` + `collection_members`.
|
||||
- Community validation with `car_votes`, `confirmation_count`, and verification state.
|
||||
|
||||
A few resources to get you started if this is your first Flutter project:
|
||||
## Local Development
|
||||
|
||||
- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter)
|
||||
- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
|
||||
- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources)
|
||||
1. Install Flutter (stable) and run `flutter doctor`.
|
||||
2. Configure Supabase keys in app configuration.
|
||||
3. Install dependencies:
|
||||
|
||||
For help getting started with Flutter development, view the
|
||||
[online documentation](https://docs.flutter.dev/), which offers tutorials,
|
||||
samples, guidance on mobile development, and a full API reference.
|
||||
```bash
|
||||
flutter pub get
|
||||
```
|
||||
|
||||
4. Run the app:
|
||||
|
||||
```bash
|
||||
flutter run
|
||||
```
|
||||
|
||||
## Quality Check
|
||||
|
||||
```bash
|
||||
flutter analyze
|
||||
```
|
||||
|
||||
## Reference
|
||||
|
||||
- Product and backend requirements: `TPB.md`
|
||||
|
|
|
|||
Loading…
Reference in a new issue