Skip to content

Quick Start

Get AgentReady Stack running and start building with AI in under 5 minutes.

Prerequisites

  • Node.js 22+Download
  • pnpm 9+ — Install with npm install -g pnpm
  • Docker — For local MongoDB and MailHog

Installation

bash
# Navigate to your project directory
cd agentready-stack

# Install dependencies
pnpm install

# Start Docker services (MongoDB, MailHog)
pnpm docker:up

# Copy environment files
cp apps/api/.env.example apps/api/.env
cp apps/web/.env.example apps/web/.env

# Start development servers
pnpm dev

Access Points

Once running, you can access:

ServiceURLDescription
Web Apphttp://localhost:3001React Router frontend
APIhttp://localhost:3000NestJS backend
API Docshttp://localhost:3000/apiSwagger/OpenAPI
MongoDB UIhttp://localhost:8081Mongo Express
Email UIhttp://localhost:8025MailHog inbox

First Steps

1. Create an Account

Visit http://localhost:3001/register to create your first user.

2. Check Your Email

Open MailHog to see the verification email and click the link.

3. Create an Organization

After verifying, you can create your first organization and start inviting members.

Available Commands

bash
# Development
pnpm dev              # Start all apps in dev mode
pnpm build            # Build all apps
pnpm lint             # Lint all packages
pnpm typecheck        # Type check all packages

# Testing
pnpm test             # Run all unit tests
pnpm test:e2e         # Run E2E tests
pnpm test:all         # Run all tests (unit + E2E)
pnpm test:coverage    # Run tests with coverage

# Code Generation
pnpm codegen          # Regenerate API client from OpenAPI

# Docker
pnpm docker:up        # Start Docker services
pnpm docker:down      # Stop Docker services
pnpm docker:logs      # View Docker logs

# Individual Apps
pnpm --filter @platform/api dev    # Start only API
pnpm --filter @platform/web dev    # Start only Web
pnpm --filter @platform/cli watch  # Watch CLI for changes (rebuilds on save)

CLI Usage

After building (pnpm build), you can use the CLI:

bash
# Login via browser
node apps/cli/bin/run.js auth login

# Check auth status
node apps/cli/bin/run.js auth status

# List organizations
node apps/cli/bin/run.js orgs list

# Logout
node apps/cli/bin/run.js auth logout

Environment Variables

API (apps/api/.env)

VariableDescriptionDefault
PORTAPI port3000
LOG_LEVELLogging levelinfo
MONGODB_URIMongoDB connection stringRequired
MONGODB_DATABASEDatabase nameRequired
JWT_SECRETJWT signing secret (32+ chars)Required
JWT_EXPIRES_INAccess token expiry15m
JWT_REFRESH_EXPIRES_INRefresh token expiry7d
CORS_ORIGINAllowed CORS originshttp://localhost:3001
FRONTEND_URLFrontend URL for emailshttp://localhost:3001
SMTP_HOSTSMTP server hostlocalhost
SMTP_PORTSMTP server port1025
SMTP_SECUREEnable TLS for SMTPfalse
SMTP_USERSMTP usernameOptional
SMTP_PASSSMTP passwordOptional
EMAIL_FROMSender email address"Platform" <[email protected]>

Web (apps/web/.env)

VariableDescriptionDefault
SESSION_SECRETCookie encryption secretRequired
API_URLBackend API URLhttp://localhost:3000
LOG_LEVELLogging levelinfo

Next Steps

  1. Read the AI Workflow — Learn how to prompt your AI agent effectively
  2. Explore the Architecture — Understand what your AI agent will be working with
  3. Start building — Point Claude at the codebase and describe your first feature