Sim Studio

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

Run

1. Run on our cloud-hosted version
2. 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

# Create environment file
cp .env.example .env

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

After running these commands:

1. Access the Application:

   • Open http://localhost:3000/w/ in your browser
   • The /w/ path is where the main workspace interface is located

2. Useful Docker Commands:

   # View application logs
   docker compose logs -f simstudio
   
   # Access PostgreSQL database
   docker compose exec db psql -U postgres -d simstudio
   
   # Stop the environment
   docker compose down
   
   # Rebuild and restart (after code changes)
   docker compose up -d --build
   

Option 2: Dev Containers

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

Option 3: Manual Setup

1. Install Dependencies

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

# Install dependencies
npm install

2. Set Up Environment

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

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

3. Set Up Database

# Push the database schema
npx drizzle-kit push

4. Start Development Server

# Start the development server
npm run dev

5. 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