Quick Start Guide

Get up and running with Clean Stack in minutes.

Prerequisites

Before you begin, ensure you have installed:

• Node.js 18 or higher
• Bun 1.0 or higher
• Docker and Docker Compose

Need help installing? Check our detailed Installation Guide.

Create Your Project

# Create a new Clean Stack project
bun create clean-stack-app my-app

cd my-app
bun install

Start Development Environment

1. Start platform services:

bun run platform:all

2. Start development server:

bun run dev

Your environment is now running with:

• Main service: http://localhost:3000
• User service: http://localhost:3001
• Grafana (Observability): http://localhost:3000
• Redis Commander: http://localhost:13333

Verify Setup

Test the health endpoint:

curl http://localhost:3000/health

Expected response:

{
  "status": "ok",
  "version": "1.0.0"
}

Next Steps

1. Explore Your Project: Review the Project Structure to understand the codebase organization.

2. Platform Features: Learn about built-in capabilities:

   • Caching
   • Observability

3. Architecture: Understand our Architecture Philosophy