mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-09 15:07:55 -05:00
88f7490a30723175763ff5684ba25c631b13b730
Sim Studio
Sim Studio is a powerful, user-friendly platform for building, testing, and optimizing agentic workflows.
Run
- Self-host
- Join the Waitlist for the cloud-hosted beta
Quick Start
Try Instantly With Zero Installation
npx simstudio
This instantly runs Sim Studio on your local machine with data stored in your browser's localStorage. Visit http://localhost:3000 to start building your workflows right away!
Development Setup
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: Cursor / VS Code Dev Containers
For the best development experience:
- Install Cursor or VS Code
- Install the Remote - Containers extension
- Open the project in Cursor or VS Code
- Click "Reopen in Container" when prompted
- Run
npm run devin the terminal
Option 3: Manual Setup
If you prefer not to use Docker or Dev Containers:
- 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
Description
Languages
TypeScript
69.6%
MDX
29.9%
Python
0.2%
CSS
0.1%