Docs are not available for mobile use. Please use a desktop computer to view the documentation.

Getting Started - Apps

This guide covers the essential setup for each Jaces application.

🚨 Alert: Jaces is building towards a beta. All documentation is subject to changes.

Web App

The SvelteKit-based frontend that serves as your main interface and API gateway.

Quick Start

# Start entire stack including web app
make dev

# Or with database browser
make dev-studio

# Access at http://localhost:3000

Key Features

Data visualization and boundary detection
Source configuration and management
API gateway for all Jaces components
Real-time sync status monitoring

Development Commands

cd apps/web
pnpm dev              # Start dev server
pnpm build            # Build for production
pnpm db:studio        # Open database browser
pnpm check            # Type checking

Tech Stack: SvelteKit 2.x, TypeScript, Tailwind CSS 4.0, PostgreSQL with Drizzle ORM

For comprehensive setup and development details, see the main getting started guide which covers the foundational web app architecture.

iOS App

Continuously captures your digital life - audio, location, screen time, and personal data.

Prerequisites

macOS with Xcode 15.0+
iOS device or Simulator (iOS 15.0+)
Running Jaces backend (see main guide above)

Quick Start

cd apps/ios
open Jaces-ios.xcodeproj

# Configure team & bundle ID in Xcode
# Update backend URL in NetworkManager.swift
# Build and run (⌘+R)

Key Features

24/7 background audio recording with voice activity detection
Continuous GPS tracking and location context
Calendar and HealthKit integration
Local SQLite buffering with automatic sync

Required Permissions

Microphone (for audio recording)
Location (always-on for GPS tracking)
Calendar (for event integration)
HealthKit (for health metrics)

Architecture: Background audio mode for 24/7 operation, Opus encoding, local buffer with retry logic

Mac App

Background service monitoring Mac activity with both GUI and headless modes.

Prerequisites

macOS 12.0+ (Monterey or later)
Running Jaces backend

Quick Start

# Build and install
make mac-install

# Run in GUI mode
make mac-run

# Run as background service
make mac-headless

Key Features

System activity and app usage monitoring
File system change tracking
Queue management with crash recovery
Configurable sync schedules

Required Permissions

Screen Recording (for app usage monitoring)
Accessibility (for activity detection)
Full Disk Access (for comprehensive monitoring)

Modes: GUI mode for configuration, headless mode for background service operation

Google Auth Proxy

OAuth proxy service for Google API integrations.

Important Note

99.99% of users don’t need to self-host this. The default hosted proxy at auth.jaces.app handles OAuth flows securely without storing credentials.

When You Might Need Self-Hosting

Corporate security requirements
Custom OAuth application needs
Air-gapped environments

Quick Start (Advanced Users)

cd services/google-auth-proxy

# Configure OAuth credentials
cp .env.example .env
# Edit .env with your Google OAuth app details

# Deploy
make deploy-proxy

Key Features

Secure OAuth flow handling
No credential storage (stateless design)
Integration with main Jaces instance
Multiple deployment options

Security: Emphasizes zero credential storage and minimal attack surface

Development Workflow

All Apps Local Development

# Start backend services
make dev

# Each app directory has its own development setup:
cd apps/web && pnpm dev          # Web development
cd apps/ios && open *.xcodeproj  # iOS development  
cd apps/mac && open *.xcodeproj  # Mac development

Testing Integration

Start backend with make dev
Configure each app to point to localhost:3000
Test data flow between apps and backend
Monitor sync status in web UI

For detailed development workflows, architecture details, and troubleshooting, see the comprehensive guides in each app directory’s documentation.