sim/README.md

Sim Studio

Sim Studio is a powerful, user-friendly platform that allows developers and agents to build, test, and optimize agentic workflows.

Run

1. Self-host
2. Join the Waitlist for the cloud-hosted beta

Quick Start

The quickest way to get Sim Studio running locally:

1. Clone the repository

git clone https://github.com/simstudioai/sim.git
cd sim

2. Start with Docker

docker compose up -d

Or use the convenience script for automatic setup:

chmod +x start_simstudio_docker.sh
./start_simstudio_docker.sh

This will start Sim Studio at http://localhost:3000 with a local PostgreSQL database.

3. [Optional] Configure Your Environment

In .env, configure Authentication secrets (required for login functionality) and optionally a Resend API key (for authentication emails).

Development Options

Option 1: Docker (Recommended)

The quickest way to get started with development:

docker compose up -d

Or use the convenience script for automatic setup:

chmod +x start_simstudio_docker.sh
./start_simstudio_docker.sh

Option 2: VS Code / Cursor Dev Containers

For a great development experience with VS Code or Cursor:

1. Install Prerequisites

   • Visual Studio Code
   • Docker Desktop
   • Remote - Containers extension for VS Code

2. Open in Container

   • Open the project in VS Code
   • When prompted, click "Reopen in Container" (or use F1 → "Remote-Containers: Reopen in Container")
   • Wait for the container to build and initialize

3. Start Developing

   • The container automatically sets up your environment
   • Type sim-start in the terminal to run the development server

This method works with GitHub Codespaces too - just click "Code" → "Codespaces" → "Create codespace on main".

Option 3: Manual Setup

If you prefer not to use Docker:

1. Install dependencies

npm install

2. Set up environment variables

Copy .env.example to .env and configure:

• Database connection (PostgreSQL)
• Authentication secret
• Email provider (Resend)

3. Set up the database

# Push the database schema
npx drizzle-kit push

4. Start the development server

npm run dev

5. Open http://localhost:3000

Tech Stack

• Framework: Next.js (App Router)
• Database: PostgreSQL with Drizzle ORM
• Authentication: Better Auth with GitHub OAuth
• UI: Shadcn, Tailwind CSS
• State Management: Zustand
• Flow Editor: ReactFlow

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ by the Sim Studio Team