This document covers environment variables, secrets, and platform-specific configuration required to build and run Chirp.
No global environment variables are required for a basic build. Platform-specific configuration is handled through local files that are git-ignored.
Some modules apply the dev.gaddal.convention.buildkonfig convention plugin. When applied, you *
must* define API_KEY in local.properties at the repository root, or the build will fail.
Add the following to local.properties (do not commit this file):
API_KEY=your_value_here| Module | Description |
|---|---|
core:data |
Core data layer API configuration |
feature:chat:data |
Chat feature API configuration |
Note: The generated package name for BuildKonfig is derived from the module path via
pathToPackageName().
The Android app applies com.google.gms.google-services. You need to provide your Firebase
configuration:
- Create a Firebase project at Firebase Console
- Add an Android app with package name
dev.gaddal.chirp - Download
google-services.json - Place it in
composeApp/google-services.json
Important: This file is git-ignored. Do not commit Firebase credentials.
For iOS push notifications:
- Configure APNs certificates/keys in your Apple Developer account
- Add Firebase iOS app in Firebase Console
- Download
GoogleService-Info.plist - Place it in the iOS target (under
iosAppas required by your Xcode setup) - Enable capabilities in Xcode:
- Push Notifications
- Background Modes → Remote notifications
TODO: Document exact file path and capabilities once finalized.
The Room convention plugin configures schemaDirectory to <module>/schemas.
| Module | Schema Path |
|---|---|
feature/chat/database |
feature/chat/database/schemas |
- Commit schemas to version control for reliable migration testing
- Schema files are auto-generated when Room entities change
- Review schema changes in PRs to catch unintended database modifications
The app registers the custom URL scheme chirp for deep linking on desktop via Conveyor
configuration.
url-schemes = ["chirp"]Windows App URI handler is configured for chirp.pl-coding.com:
// In conveyor.conf
app {
windows {
// App URI handler configuration
}
}For release builds, configure signing locally:
- Create or use an existing keystore
- Add signing configuration to
local.properties:
RELEASE_STORE_FILE=path/to/keystore.jks
RELEASE_STORE_PASSWORD=your_store_password
RELEASE_KEY_ALIAS=your_key_alias
RELEASE_KEY_PASSWORD=your_key_passwordImportant: Never commit keystores or signing credentials to version control.
# Windows
.\gradlew.bat :composeApp:assembleRelease
# macOS/Linux
./gradlew :composeApp:assembleRelease# Windows
.\gradlew.bat :composeApp:bundleRelease
# macOS/Linux
./gradlew :composeApp:bundleRelease| Configuration | Purpose | Status |
|---|---|---|
| API endpoints | Ktor client configuration | Use BuildKonfig |
| Feature flags | Runtime feature toggles | Not implemented |
| Analytics | Usage tracking | Not implemented |
Security Note: Use BuildKonfig or another secure mechanism for non-secret config. Avoid committing secrets to version control.