Skip to content

Latest commit

 

History

History
144 lines (96 loc) · 3.14 KB

quickstart.md

File metadata and controls

144 lines (96 loc) · 3.14 KB

Quick Start

Get ACP Mobile running on your device in 5 minutes.

Prerequisites

  • Node.js 20+ (Download)
  • iOS Simulator (macOS with Xcode) OR Android Emulator (Android Studio)
  • Expo Go app (optional, for testing on physical device)

Installation

# Clone the repository
git clone https://github.com/ambient-code/acp-mobile.git
cd acp-mobile

# Install dependencies
npm install

# Start development server
npm start

Run on Device

iOS Simulator (macOS only)

npm run ios

This opens the app in the iOS Simulator.

Android Emulator

npm run android

This opens the app in the Android Emulator.

Physical Device (Easiest)

  1. Install Expo Go from App Store (iOS) or Google Play (Android)
  2. Run npm start
  3. Scan the QR code displayed in terminal with:
    • iOS: Camera app
    • Android: Expo Go app

First Launch

The app currently uses mock data for development:

  • Mock Sessions: Pre-populated with test sessions
  • Mock SSE: Simulates real-time updates every 10-15 seconds
  • No Backend Required: Works offline out of the box

Dashboard Overview

You'll see:

  • Time-based greeting (Good morning/afternoon/evening/night)
  • Quick action buttons ("Interactive" and "5 Running")
  • Active sessions with progress bars
  • Model badges (sonnet-4.5, opus-4.5)

Try These Features

  1. Tap a session card - View detailed session information
  2. Pull down to refresh - Refresh session list
  3. Tap "View All" - See all sessions with filters
  4. Watch progress bars - Auto-update every 10-15 seconds
  5. Tap avatar (top-right) - Open user menu

Switching to Real API

To connect to the actual ACP backend:

  1. Update API URL in utils/constants.ts:

    export const API_BASE_URL =
  'https://ambient-code.apps.rosa.vteam-stage.7fpc.p3.openshiftapps.com'

  2. Disable mock data in hooks/useSessions.ts:

    const USE_MOCK_DATA = false

  3. Disable mock SSE in hooks/useRealtimeSession.ts:

    const USE_MOCK_SSE = false

  4. Configure OAuth (see Setup Guide)

Development Commands

# Start dev server
npm start

# Run on iOS
npm run ios

# Run on Android
npm run android

# Check for linting errors
npm run lint

# Fix linting errors
npm run lint:fix

# Format code
npm run format

# Type check
npm run type-check

# Run all checks
npm run validate

Next Steps

Getting Help

Ready to build? Check out the Development Backlog for upcoming features and improvements.