Appearance
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 devAccess Points
Once running, you can access:
| Service | URL | Description |
|---|---|---|
| Web App | http://localhost:3001 | React Router frontend |
| API | http://localhost:3000 | NestJS backend |
| API Docs | http://localhost:3000/api | Swagger/OpenAPI |
| MongoDB UI | http://localhost:8081 | Mongo Express |
| Email UI | http://localhost:8025 | MailHog 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 logoutEnvironment Variables
API (apps/api/.env)
| Variable | Description | Default |
|---|---|---|
PORT | API port | 3000 |
LOG_LEVEL | Logging level | info |
MONGODB_URI | MongoDB connection string | Required |
MONGODB_DATABASE | Database name | Required |
JWT_SECRET | JWT signing secret (32+ chars) | Required |
JWT_EXPIRES_IN | Access token expiry | 15m |
JWT_REFRESH_EXPIRES_IN | Refresh token expiry | 7d |
CORS_ORIGIN | Allowed CORS origins | http://localhost:3001 |
FRONTEND_URL | Frontend URL for emails | http://localhost:3001 |
SMTP_HOST | SMTP server host | localhost |
SMTP_PORT | SMTP server port | 1025 |
SMTP_SECURE | Enable TLS for SMTP | false |
SMTP_USER | SMTP username | Optional |
SMTP_PASS | SMTP password | Optional |
EMAIL_FROM | Sender email address | "Platform" <[email protected]> |
Web (apps/web/.env)
| Variable | Description | Default |
|---|---|---|
SESSION_SECRET | Cookie encryption secret | Required |
API_URL | Backend API URL | http://localhost:3000 |
LOG_LEVEL | Logging level | info |
Next Steps
- Read the AI Workflow — Learn how to prompt your AI agent effectively
- Explore the Architecture — Understand what your AI agent will be working with
- Start building — Point Claude at the codebase and describe your first feature