mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-09 23:17:59 -05:00
docs: updated README.md and CONTRIBUTING.md
This commit is contained in:
@@ -393,43 +393,4 @@ Happy coding!
|
||||
|
||||
---
|
||||
|
||||
## Local Storage Mode
|
||||
|
||||
Sim Studio supports a local storage mode that uses the browser's localStorage instead of a database. This is particularly useful for:
|
||||
|
||||
- Quick demos and testing
|
||||
- Using the `npx simstudio` command
|
||||
- Development without setting up a database
|
||||
- Creating shareable examples
|
||||
|
||||
To enable local storage mode:
|
||||
|
||||
1. Set the environment variable: `USE_LOCAL_STORAGE=true`
|
||||
2. Start the application: `npm run dev`
|
||||
|
||||
All data will be stored in the browser's localStorage. This means:
|
||||
|
||||
- Data persists between browser sessions
|
||||
- Different browsers (Chrome vs. Firefox) will have separate data stores
|
||||
- Database migrations and schema changes won't affect local storage
|
||||
|
||||
### Standalone Build
|
||||
|
||||
The `npx simstudio` command downloads and runs a pre-built standalone version of Sim Studio. To build this standalone version:
|
||||
|
||||
1. Run `node scripts/build-standalone.js` from the project root
|
||||
2. This creates a tarball (`sim-standalone.tar.gz`) containing:
|
||||
|
||||
- A pre-built static export of the Next.js application
|
||||
- A simple Express server to serve the static files
|
||||
- Configuration for localStorage mode
|
||||
|
||||
3. To release a new version:
|
||||
- Upload the tarball to a GitHub release
|
||||
- Update the `DOWNLOAD_URL` in `packages/simstudio/src/commands/start.ts`
|
||||
- Update the `STANDALONE_VERSION` constant if needed
|
||||
- Publish the package: `npm run publish-cli`
|
||||
|
||||
---
|
||||
|
||||
Thank you for taking the time to contribute to Sim Studio. We truly appreciate your efforts and look forward to collaborating with you!
|
||||
|
||||
17
README.md
17
README.md
@@ -11,18 +11,9 @@
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Try Instantly With Zero Installation
|
||||
There are several ways to get started with Sim Studio:
|
||||
|
||||
```bash
|
||||
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)
|
||||
### Option 1: Docker Environment (Recommended)
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
@@ -35,7 +26,7 @@ docker compose up -d
|
||||
./scripts/start_simstudio_docker.sh
|
||||
```
|
||||
|
||||
#### Option 2: [Cursor](https://cursor.sh) / [VS Code](https://code.visualstudio.com) Dev Containers
|
||||
### Option 2: [Cursor](https://cursor.sh) / [VS Code](https://code.visualstudio.com) Dev Containers
|
||||
|
||||
For the best development experience:
|
||||
|
||||
@@ -45,7 +36,7 @@ For the best development experience:
|
||||
4. Click "Reopen in Container" when prompted
|
||||
5. Run `npm run dev` in the terminal
|
||||
|
||||
#### Option 3: Manual Setup
|
||||
### Option 3: Manual Setup
|
||||
|
||||
If you prefer not to use Docker or Dev Containers:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user