You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .devcontainer/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Sim Studio Development Container
1
+
# Sim Development Container
2
2
3
3
This directory contains configuration files for Visual Studio Code Dev Containers / GitHub Codespaces. Dev containers provide a consistent, isolated development environment for this project.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
-
# Contributing to Sim Studio
1
+
# Contributing to Sim
2
2
3
-
Thank you for your interest in contributing to Sim Studio! Our goal is to provide developers with a powerful, user-friendly platform for building, testing, and optimizing agentic workflows. We welcome contributions in all forms—from bug fixes and design improvements to brand-new features.
3
+
Thank you for your interest in contributing to Sim! Our goal is to provide developers with a powerful, user-friendly platform for building, testing, and optimizing agentic workflows. We welcome contributions in all forms—from bug fixes and design improvements to brand-new features.
4
4
5
5
> **Project Overview:**
6
-
> Sim Studio is a monorepo using Turborepo, containing the main application (`apps/sim/`), documentation (`apps/docs/`), and shared packages (`packages/`). The main application is built with Next.js (app router), ReactFlow, Zustand, Shadcn, and Tailwind CSS. Please ensure your contributions follow our best practices for clarity, maintainability, and consistency.
6
+
> Sim is a monorepo using Turborepo, containing the main application (`apps/sim/`), documentation (`apps/docs/`), and shared packages (`packages/`). The main application is built with Next.js (app router), ReactFlow, Zustand, Shadcn, and Tailwind CSS. Please ensure your contributions follow our best practices for clarity, maintainability, and consistency.
7
7
8
8
---
9
9
@@ -130,7 +130,7 @@ To set up your local development environment:
130
130
131
131
### Option 1: Using NPM Package (Simplest)
132
132
133
-
The easiest way to run Sim Studio locally is using our NPM package:
133
+
The easiest way to run Sim locally is using our NPM package:
134
134
135
135
```bash
136
136
npx simstudio
@@ -140,7 +140,7 @@ After running this command, open [http://localhost:3000/](http://localhost:3000/
140
140
141
141
#### Options
142
142
143
-
-`-p, --port <port>`: Specify the port to run Sim Studio on (default: 3000)
143
+
-`-p, --port <port>`: Specify the port to run Sim on (default: 3000)
144
144
-`--no-pull`: Skip pulling the latest Docker images
145
145
146
146
#### Requirements
@@ -154,23 +154,23 @@ After running this command, open [http://localhost:3000/](http://localhost:3000/
@@ -276,7 +276,7 @@ When working on email templates, you can preview them using a local email previe
276
276
277
277
## Adding New Blocks and Tools
278
278
279
-
Sim Studio is built in a modular fashion where blocks and tools extend the platform's functionality. To maintain consistency and quality, please follow the guidelines below when adding a new block or tool.
279
+
Sim is built in a modular fashion where blocks and tools extend the platform's functionality. To maintain consistency and quality, please follow the guidelines below when adding a new block or tool.
280
280
281
281
### Where to Add Your Code
282
282
@@ -443,7 +443,7 @@ Maintaining consistent naming across the codebase is critical for auto-generatio
443
443
444
444
### Parameter Visibility System
445
445
446
-
Sim Studio implements a sophisticated parameter visibility system that controls how parameters are exposed to users and LLMs in agent workflows. Each parameter can have one of four visibility levels:
446
+
Sim implements a sophisticated parameter visibility system that controls how parameters are exposed to users and LLMs in agent workflows. Each parameter can have one of four visibility levels:
447
447
448
448
| Visibility | User Sees | LLM Sees | How It Gets Set |
@@ -509,7 +509,7 @@ This project is licensed under the Apache License 2.0. By contributing, you agre
509
509
510
510
By contributing to this repository, you agree that your contributions are provided under the terms of the Apache License Version 2.0, as included in the LICENSE file of this repository.
511
511
512
-
In addition, by submitting your contributions, you grant Sim Studio, Inc. ("The Licensor") a perpetual, irrevocable, worldwide, royalty-free, sublicensable right and license to:
512
+
In addition, by submitting your contributions, you grant Sim, Inc. ("The Licensor") a perpetual, irrevocable, worldwide, royalty-free, sublicensable right and license to:
513
513
514
514
- Use, copy, modify, distribute, publicly display, publicly perform, and prepare derivative works of your contributions.
515
515
- Incorporate your contributions into other works or products.
@@ -521,4 +521,4 @@ If you do not agree with these terms, you must not contribute your work to this
521
521
522
522
---
523
523
524
-
Thank you for taking the time to contribute to Sim Studio. We truly appreciate your efforts and look forward to collaborating with you!
524
+
Thank you for taking the time to contribute to Sim. We truly appreciate your efforts and look forward to collaborating with you!
@@ -95,7 +95,7 @@ docker compose -f docker-compose.prod.yml up -d
95
95
-[Bun](https://bun.sh/) runtime
96
96
- PostgreSQL 12+ with [pgvector extension](https://github.com/pgvector/pgvector) (required for AI embeddings)
97
97
98
-
**Note:** Sim Studio uses vector embeddings for AI features like knowledge bases and semantic search, which requires the `pgvector` PostgreSQL extension.
98
+
**Note:** Sim uses vector embeddings for AI features like knowledge bases and semantic search, which requires the `pgvector` PostgreSQL extension.
99
99
100
100
1. Clone and install dependencies:
101
101
@@ -186,4 +186,4 @@ We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTI
186
186
187
187
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
188
188
189
-
<palign="center">Made with ❤️ by the Sim Studio Team</p>
0 commit comments