mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-10 07:27:57 -05:00
93 lines
2.7 KiB
Markdown
93 lines
2.7 KiB
Markdown
# Sim Studio
|
|
|
|
<p align="center">
|
|
<!-- You can add your logo here -->
|
|
<h3 align="center">Agent Workflow Testing Platform</h3>
|
|
</p>
|
|
|
|
## Overview
|
|
|
|
Sim Studio is an open-source, drag-and-drop workflow builder designed specifically for developers to test and simulate API workflows. Think of it as Postman evolved - with a focus on visual workflow creation, real-time testing, and developer experience.
|
|
|
|
### Key Features
|
|
|
|
- 🎨 **Visual Workflow Builder** - Intuitive drag-and-drop interface for creating complex API workflows
|
|
- ⚡ **Fast & Responsive** - Built with performance in mind using Next.js
|
|
- 🔄 **Real-time Testing** - Instant feedback as you build and modify your workflows
|
|
- 🛠️ **Developer-First** - Created by developers, for developers
|
|
- 📱 **Modern UI/UX** - Clean, intuitive interface that stays out of your way
|
|
|
|
## Icons Library
|
|
|
|
Sim Studio comes with a comprehensive set of built-in icons for your workflows:
|
|
|
|
`AirplaneIcon`, `AmbulanceIcon`, `ApiIcon`, `AtomIcon`, `BankIcon`, `BoatIcon`, `BrightIcon`, `CalendarIcon`, `CancelIcon`, `ChartBarIcon`, `ChromeIcon`, `CodeIcon`, `ComponentIcon`, `ConditionalIcon`, `CookieIcon`, `CrateIcon`, `CreditCardIcon`, `DatabaseIcon`, `DollarIcon`, `ElevatorIcon`, `ErrorIcon`, `MailIcon`, `MessagesIcon`, `NotificationsIcon`, `ReminderIcon`, `SectionIcon`, `SignalIcon`, `StudentIcon`, `TrashIcon`, `UploadIcon`, `WarnIcon`, `WorkIcon`
|
|
|
|
All icons are available as React components and can be imported from `components/icons.tsx`:
|
|
|
|
```tsx
|
|
import { ApiIcon, CodeIcon, ErrorIcon } from '@/components/icons'
|
|
|
|
// Usage
|
|
;<ApiIcon className="w-6 h-6" />
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 18.0 or later
|
|
- npm (Node Package Manager)
|
|
|
|
### Installation
|
|
|
|
1. Clone the repository
|
|
|
|
```bash
|
|
git clone https://github.com/emir-karabeg/sim.git
|
|
cd sim-studio
|
|
```
|
|
|
|
2. Install dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. Start the development server
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
4. Open [http://localhost:3000](http://localhost:3000) in your browser to see Sim Studio in action
|
|
|
|
## Why Sim Studio?
|
|
|
|
- **Easy to Use**: Visual workflow building that doesn't sacrifice power
|
|
- **Fast**: Built on Next.js for optimal performance
|
|
- **Reliable**: Robust testing capabilities you can trust
|
|
- **Open Source**: Community-driven development and transparency
|
|
|
|
## 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.
|
|
|
|
## Support
|
|
|
|
- 📚 [Documentation](docs/README.md)
|
|
- 💬 [Discord Community](your-discord-link)
|
|
- 🐛 [Issue Tracker](issues)
|
|
|
|
## Acknowledgments
|
|
|
|
Built with [Next.js](https://nextjs.org/) and lots of ☕
|
|
|
|
---
|
|
|
|
<p align="center">Made with ❤️ by the Sim Studio Team</p>
|