LettuceAI

Official application repository for LettuceAI

Overview • Install • Development • Android • Contributing

Overview

This repository contains the LettuceAI application. LettuceAI is a privacy-first, cross‑platform roleplay and storytelling app built with Tauri v2, React, and TypeScript. It runs locally, keeps data on‑device, and lets users bring their own API keys and models.

Install

Prerequisites

• Bun 1.1+ (includes Node.js compatibility): https://bun.sh/
• Rust 1.70+ and Cargo
• Android SDK (optional, for Android builds)

Quick Start

# Clone the repository
git clone https://github.com/LettuceAI/mobile-app.git
cd mobile-app

# Install dependencies
bun install

Development

Common Commands

# Desktop (Tauri)
bun run tauri dev
bun run tauri build

# Android
bun run tauri android dev
bun run tauri android build

# Quality
bunx tsc --noEmit
bun run check

Android

Setup

• Install Android Studio and set up the SDK
• Ensure ANDROID_SDK_ROOT is set in your environment
• Add platform tools to your PATH (example: export PATH=$ANDROID_SDK_ROOT/platform-tools:$PATH)

Build and Run

# Run on Android emulator
bun run tauri android dev

# Build Android APK
bun run tauri android build

Contributing

We welcome contributions.

1. Fork the repo
2. Create a feature branch git checkout -b feature/my-change
3. Follow TypeScript and React best practices
4. Test your changes
5. Commit with clear, conventional messages
6. Push and open a PR

License

GNU Affero General Public License v3.0 — see LICENSE

Privacy-first • Local-first • Open Source