File tree Expand file tree Collapse file tree 2 files changed +71
-3
lines changed
Expand file tree Collapse file tree 2 files changed +71
-3
lines changed Original file line number Diff line number Diff line change @@ -168,9 +168,38 @@ Docker provides a consistent development environment with all dependencies pre-c
168168 - Edit files in your local directory
169169 - Changes will be automatically reflected thanks to hot-reloading
170170
171- ### Option 2: Manual Setup
171+ ### Option 2: Using VS Code / Cursor Dev Containers
172172
173- If you prefer not to use Docker:
173+ Dev Containers provide a consistent and easy-to-use development environment:
174+
175+ 1 . ** Prerequisites:**
176+
177+ - Visual Studio Code
178+ - Docker Desktop
179+ - [ Remote - Containers] ( https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers ) extension for VS Code
180+
181+ 2 . ** Setup Steps:**
182+ - Clone the repository:
183+ ``` bash
184+ git clone https://github.com/< your-username> /sim.git
185+ cd sim
186+ ```
187+ - Open the project in VS Code
188+ - When prompted, click " Reopen in Container" (or press F1 and select "Remote-Containers: Reopen in Container" )
189+ - Wait for the container to build and initialize
190+ 3. **Start Developing:**
191+
192+ - All dependencies and configurations are automatically set up
193+ - Use the provided aliases (like ` sim-start` ) to run common commands
194+ - Your changes will be automatically hot-reloaded
195+
196+ 4. **GitHub Codespaces:**
197+ - This setup also works with GitHub Codespaces if you prefer development in the browser
198+ - Just click " Code" → " Codespaces" → " Create codespace on main"
199+
200+ ### Option 3: Manual Setup
201+
202+ If you prefer not to use Docker or Dev Containers:
174203
1752041. **Clone the Repository:**
176205 ` ` ` bash
Original file line number Diff line number Diff line change @@ -39,7 +39,46 @@ This will start Sim Studio at http://localhost:3000 with a local PostgreSQL data
3939
4040In ` .env ` , configure Authentication secrets (required for login functionality) and optionally a Resend API key (for authentication emails).
4141
42- ## Manual Setup
42+ ## Development Options
43+
44+ ### Option 1: Docker (Recommended)
45+
46+ The quickest way to get started with development:
47+
48+ ``` bash
49+ docker compose up -d
50+ ```
51+
52+ Or use the convenience script for automatic setup:
53+
54+ ``` bash
55+ chmod +x start_simstudio_docker.sh
56+ ./start_simstudio_docker.sh
57+ ```
58+
59+ ### Option 2: VS Code / Cursor Dev Containers
60+
61+ For a great development experience with VS Code or Cursor:
62+
63+ 1 . ** Install Prerequisites**
64+
65+ - Visual Studio Code
66+ - Docker Desktop
67+ - Remote - Containers extension for VS Code
68+
69+ 2 . ** Open in Container**
70+
71+ - Open the project in VS Code
72+ - When prompted, click "Reopen in Container" (or use F1 → "Remote-Containers: Reopen in Container")
73+ - Wait for the container to build and initialize
74+
75+ 3 . ** Start Developing**
76+ - The container automatically sets up your environment
77+ - Type ` sim-start ` in the terminal to run the development server
78+
79+ This method works with GitHub Codespaces too - just click "Code" → "Codespaces" → "Create codespace on main".
80+
81+ ### Option 3: Manual Setup
4382
4483If you prefer not to use Docker:
4584
You can’t perform that action at this time.
0 commit comments