Installation Overview
Get StarterApp running locally with the right tools and configuration.
The installation process establishes the development environment, configures required services, and prepares the codebase for AI-assisted development. The workflow accommodates both manual setup and AI-guided automation.
AI-First Installation
StarterApp provides an AI-powered onboarding flow that automates environment detection, dependency installation, and initial configuration. The /llms/commands/initialize.md
command guides through the entire setup process.
Installation Paths
Two approaches are available for getting started:
AI Onboarding
Automated setup flow with AI guidance for tool detection, dependency installation, and environment configuration.
Manual Setup
Step-by-step installation following platform-specific guides and configuration instructions.
Platform Setup
Operating system configuration and development tools installation:
Windows Setup
WSL2 configuration, Ubuntu installation, and Windows Terminal setup for Node.js development.
Mac & Linux Setup
Homebrew, fnm, and development tools installation for Unix-based systems.
Configuration
Service credentials and environment variables:
Required Services
BetterAuth requires Google OAuth credentials. Convex needs deployment URL configuration. UseAutumn billing requires API keys. Development works with placeholder values, production requires real credentials.
AI Agent Setup
Configure AI coding assistants with StarterApp context:
Claude Code Setup
Install Claude Code CLI and configure with codebase context for AI-assisted development.
Codex Setup
Configure GitHub Copilot and Codex with StarterApp templates and architectural patterns.
IDE Setup
Editor configuration for optimal development experience:
Cursor Setup
AI-native editor configuration with StarterApp rules and context engineering.
VS Code Setup
Extensions, settings, and workspace configuration for Visual Studio Code.
Windsurf Setup
Configure Windsurf IDE with TypeScript, React, and Convex language support.
System Requirements
The development environment requires:
Quick Start Commands
After installation completes, standard development commands:
# Install dependencies
pnpm install
# Configure environment
cp .env.example .env.local
# Start development server
pnpm dev
# Run validation checks
pnpm validate
Applications run at:
- Marketing:
http://localhost:3000
- Dashboard:
http://localhost:3001
- Docs:
http://localhost:3100
Next Steps
After completing installation: