Live Captions App for AugmentOS

This app provides live captions functionality for AugmentOS smart glasses.

Development

Prerequisites

• Docker
• Bun (optional for local development)

Setup and Development

Docker Development (Recommended)

The quickest way to get started is using Docker:

# Start the development environment
bun run docker:dev

# Start in detached mode
bun run docker:dev:detach

# View logs
bun run logs

# Stop the container
bun run docker:stop

# Rebuild the container
bun run docker:build

Using Local SDK (Optional)

If you're working on both the app and SDK simultaneously, the development environment will automatically detect and use a local SDK if it's available in one of these paths:

• ../../../AugmentOS/augmentos_cloud/packages/sdk
• ../../AugmentOS/augmentos_cloud/packages/sdk
• ../../../augmentos_cloud/packages/sdk
• ../../augmentos_cloud/packages/sdk

Local Development (Without Docker)

If you prefer to develop without Docker:

# Install dependencies
bun install

# Start development server
bun run dev

Common Tasks

# Add a new package
bun run add <package-name>

# Add a dev dependency
bun run add:dev <package-name>

# Remove a package
bun run remove <package-name>

# Run tests
bun run test

# Run linter
bun run lint

# Start a shell in the container
bun run sh

License

See the LICENSE file for details.