Sim Studio

Sim Studio is a powerful, user-friendly platform for building, testing, and optimizing agentic workflows.

Run

Run on our cloud-hosted version
Self-host

How to Self-Host

Fork this repository by clicking the "Fork" button at the top right of this page.

Note: Ensure you have VS Code or another editor, git, npm, and Docker (if you're not setting up manually) installed on your system.

There are several ways to self-host Sim Studio:

Option 1: Docker Environment (Recommended)

# Clone the repository
git clone https://github.com/YOUR_USERNAME/sim.git
cd sim

# Start the Docker environment
docker compose up -d
# Or use the helper script
./scripts/start_simstudio_docker.sh

Option 2: Dev Containers

Open VS Code or your favorite VS Code fork (Cursor, Windsurf, etc.)
Install the Remote - Containers extension
Open the project in your editor
Click "Reopen in Container" when prompted
Run npm run dev in the terminal

Option 3: Manual Setup

Install Dependencies

# Clone the repository
git clone https://github.com/YOUR_USERNAME/sim.git
cd sim

# Install dependencies
npm install

Set Up Environment

# Copy .env.example to .env
cp .env.example .env

# Configure your .env file with:
# - Database connection (PostgreSQL)
# - Authentication settings

Set Up Database

# Push the database schema
npx drizzle-kit push

Start Development Server

# Start the development server
npm run dev

Open http://localhost:3000 in your browser

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

2.7 KiB Raw Blame History