mirror of
https://github.com/simstudioai/sim.git
synced 2026-04-28 03:00:29 -04:00
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
# Sim Studio
|
|
|
|
[](https://x.com/simstudioai) [](https://opensource.org/licenses/MIT)
|
|
|
|
**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](https://simstudio.ai) for the cloud-hosted beta
|
|
|
|
## Getting Started
|
|
|
|
1. Clone the repository
|
|
|
|
```bash
|
|
git clone https://github.com/simstudioai/sim.git
|
|
cd sim-studio
|
|
```
|
|
|
|
2. Install dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. Set up your environment variables
|
|
|
|
Copy `.env.example` to `.env` and configure:
|
|
|
|
- Database connection (PostgreSQL)
|
|
- Authentication secret
|
|
- Email provider (Resend)
|
|
|
|
4. Set up the database
|
|
|
|
```bash
|
|
# Push the database schema
|
|
npx drizzle-kit push
|
|
```
|
|
|
|
5. Start the development server
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
6. Open [http://localhost:3000](http://localhost:3000)
|
|
|
|
## Tech Stack
|
|
|
|
- **Framework**: [Next.js](https://nextjs.org/) (App Router)
|
|
- **Database**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team)
|
|
- **Authentication**: [Better Auth](https://better-auth.com) with GitHub OAuth
|
|
- **UI**: [Shadcn](https://ui.shadcn.com/), [Tailwind CSS](https://tailwindcss.com)
|
|
- **State Management**: [Zustand](https://zustand-demo.pmnd.rs/)
|
|
- **Flow Editor**: [ReactFlow](https://reactflow.dev/)
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
|
|
## Acknowledgments
|
|
|
|
Built with [Next.js](https://nextjs.org/), [React Flow](https://reactflow.dev/), [Zustand](https://zustand-demo.pmnd.rs/), [Shadcn/ui](https://ui.shadcn.com/), [Tailwind CSS](https://tailwindcss.com/) and lots of ☕
|
|
|
|
##
|
|
|
|
<p align="center">Made with ❤️ by the Sim Studio Team</p>
|