Commit bc54276
committed
docs: Consolidate setup guides into a single GETTING_STARTED.md
This commit consolidates all setup and production-readiness documentation into a single, comprehensive `GETTING_STARTED.md` file.
The previous documentation was fragmented across `MANUAL_SETUP_REQUIRED.md`, `NEXT_STEPS.md`, and `docs/PRODUCTION_SETUP.md`, which is now all removed. The new guide provides a unified, step-by-step walkthrough from initial project setup to Play Store deployment.
Additionally, project-specific names like "Zencastr" have been replaced with generic "App" placeholders in dispatcher enums and service class names to align with the template's reusable nature.
### Key Changes:
- **Documentation Consolidation:**
- Created `GETTING_STARTED.md` to serve as the single source of truth for setup.
- Deleted `MANUAL_SETUP_REQUIRED.md`, `NEXT_STEPS.md`, and `docs/PRODUCTION_SETUP.md`.
- Updated all references in `README.md`, `CLAUDE.md`, and other documentation to point to the new `GETTING_STARTED.md` file.
- Improved Firebase setup instructions to clarify the need for multiple package name variants (`dev`, `prod`, `debug`).
- **Code Generalization:**
- Renamed `ZencastrDispatchers` enum to `AppDispatchers` to remove project-specific branding.
- Renamed `ZencastrFCMService` to `AppFCMService`.
- Updated all related use cases, modules, and `AndroidManifest.xml` to use the new generic names.
- Changed the preference DataStore filename from `zencastr_prefs` to the more generic `myapp_prefs`.1 parent 366690c commit bc54276
16 files changed
Lines changed: 774 additions & 1163 deletions
File tree
- .github/workflows
- app/src/main
- core
- common/src/main/kotlin/com/example/common/di
- qualifiers
- datastore/preferences
- domain/src/main/java/com/example/domain/usecase
- notifications/src/main/java/com/example/notifications
- docs
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
110 | | - | |
| 110 | + | |
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
117 | | - | |
118 | | - | |
| 117 | + | |
| 118 | + | |
119 | 119 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
| 44 | + | |
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| |||
376 | 376 | | |
377 | 377 | | |
378 | 378 | | |
379 | | - | |
| 379 | + | |
380 | 380 | | |
381 | 381 | | |
382 | 382 | | |
| |||
559 | 559 | | |
560 | 560 | | |
561 | 561 | | |
562 | | - | |
| 562 | + | |
563 | 563 | | |
564 | 564 | | |
565 | 565 | | |
| |||
588 | 588 | | |
589 | 589 | | |
590 | 590 | | |
591 | | - | |
592 | | - | |
593 | | - | |
| 591 | + | |
594 | 592 | | |
595 | 593 | | |
596 | 594 | | |
| |||
0 commit comments