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
{{ message }}
Repository navigation
Commit 9cc0a93
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+4-9Lines changed: 4 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,20 +140,15 @@ Using clear and consistent commit messages makes it easier for everyone to under
140
140
141
141
To set up your local development environment:
142
142
143
-
### Option 1: Using NPM Package (Simplest)
143
+
### Option 1: Using the Setup Wizard (Simplest)
144
144
145
-
The easiest way to run Sim locally is using our NPM package:
145
+
The easiest way to run Sim locally is the `sim-setup` wizard, which creates a deployment directory, generates secrets, and starts the published images with Docker Compose:
146
146
147
147
```bash
148
-
npx simstudio
148
+
npx sim-setup
149
149
```
150
150
151
-
After running this command, open [http://localhost:3000/](http://localhost:3000/) in your browser.
152
-
153
-
#### Options
154
-
155
-
-`-p, --port <port>`: Specify the port to run Sim on (default: 3000)
156
-
-`--no-pull`: Skip pulling the latest Docker images
151
+
Inside a cloned Sim repository, run `bun run sim-setup` instead to unlock the source-only local development mode.
0 commit comments