Skip to content

Commit f0e8380

Browse files
authored
docs: correct debug applicationId and google-services.json path (#1283)
1 parent 1f64bb4 commit f0e8380

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

‎CLAUDE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Code/Flipcash is a mobile wallet app for instant, global, private payments using
2828
bundle exec fastlane android flipcash_tests
2929
```
3030

31-
**Requirements**: Java 21 (Corretto), `google-services.json` in `apps/flipcash/app/src/`, API keys in `local.properties` (BUGSNAG_API_KEY, MIXPANEL_API_KEY, COINBASE_ONRAMP_API_KEY, GOOGLE_CLOUD_PROJECT_NUMBER). Keys resolve via `tryReadProperty` (local.properties → env var → empty), so a missing key won't fail the build but disables the dependent feature. See `docs/architecture/10-build-and-run.md`.
31+
**Requirements**: Java 21 (Corretto), `google-services.json` in `apps/flipcash/app/` (CI provisions it at `apps/flipcash/app/src/`; the Google Services plugin accepts either), API keys in `local.properties` (BUGSNAG_API_KEY, MIXPANEL_API_KEY, COINBASE_ONRAMP_API_KEY, GOOGLE_CLOUD_PROJECT_NUMBER). Keys resolve via `tryReadProperty` (local.properties → env var → empty), so a missing key won't fail the build but disables the dependent feature. See `docs/architecture/10-build-and-run.md`.
3232

3333
## Module Structure
3434

@@ -91,7 +91,7 @@ The feature plugin automatically includes `:libs:logging`, `:ui:core`, `:ui:comp
9191

9292
## Namespaces
9393

94-
- App: `com.flipcash.app.android` (debug: `com.flipcash.app.android.dev`)
94+
- App: `com.flipcash.app.android` (no `applicationIdSuffix` — debug and release share the ID, so installing one replaces the other)
9595
- Legacy/shared: `com.getcode`
9696
- Features: `com.flipcash.features.*`
9797
- Shared modules: `com.flipcash.shared.*`

‎docs/architecture/08-cross-cutting-concerns.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Flow-exposure pattern, and lifecycle-aware streaming — are in
9696
`compileSdk 36`, `minSdk 29`, **Java/Kotlin 21**, all set by the convention plugins
9797
(see [01](01-modules-and-boundaries.md)). API keys (Bugsnag, Mixpanel, Coinbase
9898
on-ramp, Google Cloud project number) are read from `local.properties` and surfaced
99-
through `BuildConfig`; `google-services.json` lives under `apps/flipcash/app/src/`.
99+
through `BuildConfig`; `google-services.json` lives at `apps/flipcash/app/` (or `apps/flipcash/app/src/`).
100100
See [10 — Build & run](10-build-and-run.md) for the full list.
101101

102102
## Why this matters

‎docs/architecture/10-build-and-run.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ build actually needs from you. This is the day-one setup doc.
99
|-------------|-------|
1010
| **JDK 21** | Amazon Corretto 21 is what CI uses. The convention plugins pin the Java/Kotlin toolchain to 21 ([01](01-modules-and-boundaries.md)). |
1111
| **Android SDK** | `compileSdk 36`, `minSdk 29`, `targetSdk` per the version catalog. |
12-
| **`google-services.json`** | Required at `apps/flipcash/app/src/google-services.json` (Firebase). The build fails without it. |
12+
| **`google-services.json`** | Required (Firebase). Goes at `apps/flipcash/app/google-services.json`; the Google Services plugin also accepts `apps/flipcash/app/src/`, which is where CI provisions it. The build fails without it. |
1313
| **`local.properties`** | API keys (below) plus the standard `sdk.dir`. |
1414

1515
## API keys in `local.properties`
@@ -71,7 +71,7 @@ See [12 — Testing](12-testing.md) for the testing approach.
7171
| | Application ID |
7272
|---|----------------|
7373
| Release | `com.flipcash.app.android` |
74-
| Debug | `com.flipcash.app.android.dev` (suffix lets debug + release coexist on one device) |
74+
| Debug | `com.flipcash.app.android` — there is no `applicationIdSuffix`, so debug and release share the ID and installing one replaces the other |
7575

7676
The app forces **dark mode** (`MODE_NIGHT_YES`, see [07](07-design-system.md)).
7777
`versionCode` comes from `Packaging.Flipcash.versionCode` or `gitVersionCode()`.
@@ -93,7 +93,7 @@ and the upload pipeline.
9393

9494
## Troubleshooting
9595

96-
- **`google-services.json` missing** → place it at `apps/flipcash/app/src/`.
96+
- **`google-services.json` missing** → place it at `apps/flipcash/app/` (or `apps/flipcash/app/src/`).
9797
- **A feature behaves as if unconfigured** (no analytics, on-ramp fails) → the
9898
corresponding key is absent from `local.properties` (the build won't warn loudly,
9999
because the fallback is an empty string).

0 commit comments

Comments
 (0)