Files

1.8 KiB

Plugin Compass Android (Capacitor)

This folder contains the Android app build for Plugin Compass. The app provides a native mobile experience with sign-in, onboarding, and plugin building features.

Features

  • Native sign-in screen with email and OAuth options.
  • Full onboarding flow with step-by-step guidance.
  • Quick start prompts to help users get started.
  • Reuses the existing web UI for builder and apps pages.
  • Build via GitHub Actions.

How it works

  • Sign-in: Custom mobile-first sign-in screen with email/password and OAuth buttons.
  • Onboarding: 4-step onboarding flow introducing key features and quick start prompts.
  • UI reuse: After onboarding, users access the builder and apps from the web UI.
  • Local storage: Apps and preferences are saved using Capacitor Preferences.

Setup

  1. Install prerequisites (Node 18+, Android SDK).
  2. From this folder: npm install.
  3. Pull UI assets: npm run prepare-ui.
  4. Add Android platform: npx cap add android.
  5. Sync: npx cap sync android.

Development

  • npm run build prepares UI and syncs with Android.
  • npx cap open android opens Android Studio for development.

CI build

  • GitHub Actions workflow: .github/workflows/build-android-app.yml.
  • The action runs on ubuntu-latest, sets up Java/Android SDK, and builds the APK.

Custom Mobile Index

The build script creates a custom index.html for mobile with:

  • Loading screen with branded animation
  • Sign-in screen (email/password + OAuth)
  • Onboarding flow (4 steps with quick start prompts)
  • Main dashboard with quick actions

Security notes

  • User credentials are stored securely using Capacitor Preferences.
  • API keys are never exposed to the web layer.
  • OpenCode execution is not supported on mobile (desktop app only).