Skip to content

Commit bc54276

Browse files
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/README_DEPLOY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ git push
107107

108108
## Detailed Setup Guide
109109

110-
See [`MANUAL_SETUP_REQUIRED.md`](../../MANUAL_SETUP_REQUIRED.md) for complete step-by-step instructions.
110+
See [`GETTING_STARTED.md`](../../GETTING_STARTED.md) for complete step-by-step instructions.
111111

112112
---
113113

114114
## Need Help?
115115

116116
- **Build issues**: Check `build-release.yml` workflow logs
117-
- **Keystore generation**: See `MANUAL_SETUP_REQUIRED.md#3`
118-
- **Play Store setup**: See `MANUAL_SETUP_REQUIRED.md#5`
117+
- **Keystore generation**: See `GETTING_STARTED.md#41-generate-release-keystore`
118+
- **Play Store setup**: See `GETTING_STARTED.md#step-5-play-store-deployment-setup-when-ready-to-publish`
119119
- **CI/CD issues**: Check `.github/workflows/README.md`

CLAUDE.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
1818
- Create Firebase project at [Firebase Console](https://console.firebase.google.com)
1919
- Add Android app with package: `com.example.myapp` (or your chosen package name)
2020
- Download `google-services.json` and place in `app/` directory
21-
- See [MANUAL_SETUP_REQUIRED.md](MANUAL_SETUP_REQUIRED.md#1-firebase-configuration) for detailed instructions
21+
- See [GETTING_STARTED.md](GETTING_STARTED.md#12-firebase-configuration) for detailed instructions
2222
- **Note**: Update package name after rebranding the project
2323

2424
2. **Verify Setup**:
@@ -37,11 +37,11 @@ Add to GitHub repository secrets (**Settings → Secrets and variables → Actio
3737
### Optional: Release Signing (for Play Store)
3838

3939
Only needed when ready to publish to Play Store:
40-
- Generate keystore: See `MANUAL_SETUP_REQUIRED.md`
40+
- Generate keystore: See `GETTING_STARTED.md`
4141
- Create `keystore.properties` file (gitignored)
4242
- Uncomment signing config in `app/build.gradle.kts`
4343

44-
For detailed setup instructions, see `MANUAL_SETUP_REQUIRED.md` and `NEXT_STEPS.md`.
44+
For detailed setup instructions, see `GETTING_STARTED.md`.
4545

4646
## Build Commands
4747

@@ -376,7 +376,7 @@ Example: `https://example.com/content/123`
376376

377377
**Required**: Add `google-services.json` from Firebase Console to `app/` directory.
378378

379-
See [MANUAL_SETUP_REQUIRED.md](MANUAL_SETUP_REQUIRED.md#1-firebase-configuration) for detailed setup instructions:
379+
See [GETTING_STARTED.md](GETTING_STARTED.md#12-firebase-configuration) for detailed setup instructions:
380380
1. Create Firebase project
381381
2. Add Android app with your package name (e.g., `com.example.myapp`)
382382
3. Download `google-services.json`
@@ -559,7 +559,7 @@ git push origin v1.0.0
559559
```
560560

561561
**Deploy Workflow** (disabled by default):
562-
- See `MANUAL_SETUP_REQUIRED.md` for enabling Play Store deployment
562+
- See `GETTING_STARTED.md` for enabling Play Store deployment
563563
- Requires keystore setup and Play Store service account
564564

565565
## Documentation
@@ -588,9 +588,7 @@ Located in `docs/api/`:
588588
### Production Setup and Implementation
589589

590590
Production readiness documentation:
591-
- **`MANUAL_SETUP_REQUIRED.md`** - Step-by-step setup guide (Firebase, keystore, Play Store)
592-
- **`NEXT_STEPS.md`** - Quick reference and current status
593-
- **`docs/PRODUCTION_SETUP.md`** - Release keystore, signing, Play Store submission
591+
- **`GETTING_STARTED.md`** - Complete setup guide from local dev to Play Store deployment
594592

595593
**Current Status: 100% Development Ready** 🎉
596594

0 commit comments

Comments
 (0)