southseact-3d/shopify-ai-backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename to Plugin Compass, add mobile onboarding/signin, implement self-update for desktop, and fix workflow paths

Browse Source
This commit is contained in:
southseact-3d
2026-02-16 12:05:30 +00:00
parent 63698e1d19
commit d6e2af3a29
11 changed files with 945 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
android-app/README.md
View File

@@ -1,18 +1,19 @@
# Android App (Capacitor)
# Plugin Compass Android (Capacitor)
This folder contains the Android app build for the project. The app reuses the existing web UI (apps and builder screens) and wraps it with Capacitor for native Android deployment.
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.
## Goals
- Reuse the existing web UI with minimal divergence.
- Provide a native Android APK for distribution.
- Sync apps between device and backend.
- Build via GitHub Actions; do not build locally.
## 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
- **UI reuse:** `npm run prepare-ui` copies `../chat/public` into `www` and injects a bridge script so existing pages can talk to native APIs.
- **Native bridge:** Capacitor provides native access to preferences and HTTP requests.
- **Local storage:** Apps are saved using Capacitor Preferences plugin, isolated per user.
- **Syncing:** `syncApp` posts the locally saved app JSON to the backend.
- **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).
@@ -29,6 +30,14 @@ This folder contains the Android app build for the project. The app reuses the e
- 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
- API keys are stored in Capacitor Preferences (encrypted on Android).
- 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).