Skip to content

About

Native Android client for Cosmonaut AI interactive stories.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Cosmonaut Android

Native Android client for Cosmonaut AI, an AI-powered interactive storytelling platform.

Repository Role

Cosmonaut is split across several public repositories:

Stack

  • Kotlin and Jetpack Compose
  • Single-activity architecture with Navigation Compose
  • Hilt for dependency injection
  • Retrofit and kotlinx.serialization for API calls
  • AWS Amplify Cognito authentication
  • Store5 planning for cache/source-of-truth patterns
  • Sentry crash reporting and PostHog product analytics

Local Setup

Prerequisites:

  • Android Studio
  • Android SDK at ~/Library/Android/sdk
  • Java 17. For local Gradle commands on this machine, use the Android Studio bundled JDK:
export JAVA_HOME="/Applications/Android Studio.app/Contents/jbr/Contents/Home"

Build the dev APK:

./gradlew app:assembleDevDebug

The dev flavor uses application id com.cosmonaut.app.dev and points at the development Cosmonaut API.

Verification

Run the current local verification workflow before merging Android code changes:

export JAVA_HOME="/Applications/Android Studio.app/Contents/jbr/Contents/Home"
./gradlew app:lintDevDebug app:assembleDevDebug

For UI changes, install and inspect the app on an emulator or device:

adb install -r app/build/outputs/apk/dev/debug/app-dev-debug.apk
adb shell am force-stop com.cosmonaut.app.dev
adb shell am start -n com.cosmonaut.app.dev/com.cosmonaut.app.MainActivity

Release Signing

Release builds read signing configuration from environment variables or GitHub Actions secrets:

  • SIGNING_KEY
  • SIGNING_KEY_ALIAS
  • SIGNING_KEY_PASSWORD
  • SIGNING_STORE_PASSWORD
  • SIGNING_STORE_FILE
  • SENTRY_AUTH_TOKEN
  • SENTRY_ORG
  • SENTRY_PROJECT
  • POSTHOG_API_KEY
  • POSTHOG_HOST

Do not commit keystores, local signing files, generated APKs, generated AABs, or verification screenshots.

Public Configuration

Cognito IDs, Cognito domains, Sentry DSNs, and PostHog project tokens in the app build config are client-visible public configuration, not server-side secrets. Runtime signing material and Sentry upload tokens must stay in GitHub Actions secrets or local environment variables.

Documentation

Start with docs/README.md. The most useful references are:

CI/CD

GitHub Actions builds dev APKs from develop and production release artifacts from main. Artifact upload is disabled when the repository is public.

Security

See SECURITY.md for disclosure and secret-handling guidance.

Contributing

Issues and pull requests are welcome. Include emulator/device verification for UI behavior changes and keep generated build outputs out of commits.

License

Apache-2.0. See LICENSE.

About

Native Android client for Cosmonaut AI interactive stories.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages