Open Audio Mobile Platform

This is the central developer reference repository for the Open Audio mobile developer platform. It contains:

• Mobile template app - Source template for CLI scaffold
• Runnable examples hub - Browse and run examples on device
• Documentation site - Comprehensive developer documentation
• Canonical examples - Single source of truth for SDK usage patterns
• Shared packages - SDK adapters and UI primitives

Quick Start

For New Developers

Do NOT clone this repo to start building apps. Instead, use the CLI scaffold:

npx create-open-audio-mobile-app my-app

This generates a small standalone Expo app with SDK integration and example screens.

For Contributors

# Install dependencies
npm install

# Run template app
npm run dev:template

# Run examples hub
npm run dev:examples

# Run docs site
npm run dev:docs

Repository Structure

open-audio-platform/
  apps/
    template-expo/        # Source template for CLI scaffold
    examples-expo/        # Runnable examples hub app
    docs-site/            # Documentation website

  examples/               # Canonical examples (single source of truth)
    trending/
    search/
    upload/
    auth/

  packages/
    sdk-adapter/          # Optional thin wrapper for SDK initialization
    ui/                   # Shared UI primitives (optional)

  docs/
    recipes/              # LLM-friendly how-to guides
    llms.txt              # AI retrieval entry point

Examples Strategy

Each example in /examples/<example-name>/ includes:

• example.meta.json - Metadata (compatibility, requirements)
• README.mdx - Documentation
• code/ - Source code files

Examples power:

• Documentation site rendering
• Runnable Examples Hub app
• AI retrieval for coding assistance

Documentation

• Docs Site: Run npm run dev:docs to view locally
• AI-Friendly Docs: See docs/llms.txt and docs/recipes/
• Examples: Browse in examples/ or run via Examples Hub app

Versioning

SDK version, CLI template version, examples version, and docs version are aligned to avoid compatibility confusion.

Expo Compatibility

• Expo Go Compatible: Trending, search, feed browsing, basic SDK reads
• Dev Client Required: Wallet integrations, upload pipelines, push notifications, advanced audio handling

Guiding Principles

• Keep onboarding friction low - Simple template first
• Examples are the truth - Docs render examples, not vice versa
• Optimize for vibe coding - Make docs retrievable and examples structured
• Mobile-first but platform-minded - Design for future surfaces
• Clarity over cleverness - Names and structure should be obvious

License

MIT