mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-11 16:08:04 -05:00
78b5ae7b3d
* feat(logging): add additional logs for proxy routes
* fix(blocks): workflow handler not working outside gui (#609)
* fix: key to call api internally for workflow block
* feat: use jwt for internal auth to avoid a static key
* chore: formatter
* fix(sidebar): added loop & parallel subblcoks to sidebar search
* merged improvement/connection into staging (#604)
* merged improvement/connection into staging
* fix: merge conflicts and improved block path calculation
* fix: removed migration
* fix: removed duplicate call
* fix: resolver and merge conflicts
* fix: knowledge base folder
* fix: settings modal
* fix: typeform block
* fix: parallel handler
* fix: stores index
* fix: tests
* fix: tag-dropdown
* improvement: start block input and tag dropdown
* fix block id resolution + missing bracket
* fix lint
* fix test
* works
* fix
* fix lint
* Revert "fix lint"
This reverts commit 433e2f9cfc.
---------
Co-authored-by: Vikhyath Mondreti <vikhyathvikku@gmail.com>
Co-authored-by: Vikhyath Mondreti <vikhyathmondreti@Vikhyaths-MacBook-Air.local>
* fix(autopan): migration missing (#614)
* add autopan migration
* fix lint
* fix linter
* fix tests
---------
Co-authored-by: Vikhyath Mondreti <vikhyathmondreti@vikhyaths-air.lan>
---------
Co-authored-by: Waleed Latif <walif6@gmail.com>
Co-authored-by: Aditya Tripathi <aditya@climactic.co>
Co-authored-by: Emir Karabeg <78010029+emir-karabeg@users.noreply.github.com>
Co-authored-by: Vikhyath Mondreti <vikhyathmondreti@Vikhyaths-MacBook-Air.local>
Co-authored-by: Vikhyath Mondreti <vikhyathmondreti@vikhyaths-air.lan>
Sim Studio is a lightweight, user-friendly platform for building AI agent workflows.
Getting Started
- Use our cloud-hosted version
- Self-host using one of the methods below
Self-Hosting Options
Option 1: NPM Package (Simplest)
The easiest way to run Sim Studio locally is using our NPM package:
npx simstudio
After running these commands, open http://localhost:3000/ in your browser.
Options
-p, --port <port>: Specify the port to run Sim Studio on (default: 3000)--no-pull: Skip pulling the latest Docker images
Requirements
- Docker must be installed and running on your machine
Option 2: Docker Compose
# Clone the repository
git clone https://github.com/simstudioai/sim.git
# Navigate to the project directory
cd sim
# Start Sim Studio
docker compose -f docker-compose.prod.yml up -d
Access the application at http://localhost:3000/
Using Local Models
To use local models with Sim Studio:
- Pull models using our helper script:
./apps/sim/scripts/ollama_docker.sh pull <model_name>
- Start Sim Studio with local model support:
# With NVIDIA GPU support
docker compose --profile local-gpu -f docker-compose.ollama.yml up -d
# Without GPU (CPU only)
docker compose --profile local-cpu -f docker-compose.ollama.yml up -d
# If hosting on a server, update the environment variables in the docker-compose.prod.yml file to include the server's public IP then start again (OLLAMA_URL to i.e. http://1.1.1.1:11434)
docker compose -f docker-compose.prod.yml up -d
Option 3: Dev Containers
- Open VS Code with the Remote - Containers extension
- Open the project and click "Reopen in Container" when prompted
- Run
bun run dev:fullin the terminal or use thesim-startalias
Option 4: Manual Setup
- Clone and install dependencies:
git clone https://github.com/simstudioai/sim.git
cd sim
bun install
- Set up environment:
cd apps/sim
cp .env.example .env # Configure with required variables (DATABASE_URL, BETTER_AUTH_SECRET, BETTER_AUTH_URL)
- Set up the database:
bunx drizzle-kit push
- Start the development servers:
Next.js app:
bun run dev
Start the realtime server:
bun run dev:sockets
Run both together (recommended):
bun run dev:full
Tech Stack
- Framework: Next.js (App Router)
- Runtime: Bun
- Database: PostgreSQL with Drizzle ORM
- Authentication: Better Auth
- UI: Shadcn, Tailwind CSS
- State Management: Zustand
- Flow Editor: ReactFlow
- Docs: Fumadocs
- Monorepo: Turborepo
- Realtime: Socket.io
Contributing
We welcome contributions! Please see our Contributing Guide for details.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Made with ❤️ by the Sim Studio Team