Guides
Getting Started

Getting Started

This guide helps you get started with AICR platform development.

Prerequisites

  • Node.js 18+
  • pnpm 8+
  • Git
  • Neon PostgreSQL account (or use preview branches)

Quick Start

# Clone the repository
git clone https://github.com/AICodeRally/AICR.git
cd AICR
 
# Install dependencies
pnpm install
 
# Copy environment variables
cp apps/aicr/.env.example apps/aicr/.env.local
 
# Start development server
pnpm dev

Project Structure

apps/
├── aicr/          # Main platform (port 3000)
├── studio/        # Pack authoring (port 3002)
├── website/       # Marketing site (port 3001)
└── docs/          # Documentation (port 3003)

packages/
├── database/      # Prisma schema
├── packs/         # Pack system
├── contracts/     # Event schemas
└── ai-router/     # AI provider routing

docs/              # Markdown documentation
.claude/           # Agent instructions

Environment Variables

Key environment variables for apps/aicr/.env.local:

# Database (Neon PostgreSQL)
DATABASE_URL="postgresql://..."
 
# Auth
NEXTAUTH_SECRET="..."
NEXTAUTH_URL="http://localhost:3000"
 
# AI Providers
OPENAI_API_KEY="..."
ANTHROPIC_API_KEY="..."

Development Workflow

  1. Read agent docs - Check .claude/AGENTS.md for role guidance
  2. Check sprint - Review .claude/tasks/SPRINT.md for current work
  3. Announce work - State task ID and action before starting
  4. Track progress - Update task status as you work
  5. Test changes - Run tests and verify locally
  6. Commit - Follow conventional commit format

Database Operations

# Open Prisma Studio
pnpm db:studio
 
# Create migration
pnpm db:migrate:dev --name <migration-name>
 
# Generate Prisma client
pnpm prisma generate

Useful Commands

# Type checking
pnpm typecheck
 
# Linting
pnpm lint
 
# Build
pnpm build
 
# Deploy preview
vercel
 
# Deploy production
vercel --prod

Platform URLs

EnvironmentURL
Productionhttps://app.aicoderally.com (opens in a new tab)
Websitehttps://aicoderally.com (opens in a new tab)
Docshttps://docs.aicoderally.com (opens in a new tab)
RealmKey SystemDeveloper Onboarding