Skip to content

Commit 03c9cde

Browse files
authored
Update CONTRIBUTING.md
1 parent 3cfb75d commit 03c9cde

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

CONTRIBUTING.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,17 @@ Are you a first-timer in contributing to open source? [These guidelines](https:/
1515
```bash
1616
git clone https://github.com/<your-username>/algorithm-visualizer.git
1717
```
18+
19+
3. Choose whether to run [`server`](https://github.com/algorithm-visualizer/server) on your machine or to use the remote server.
20+
- If you choose to run the server locally as well, follow the instructions [here](https://github.com/algorithm-visualizer/server/blob/master/CONTRIBUTING.md#running-locally).
21+
22+
- If you choose to use the remote server, **temporarily** (i.e., don't commit this change) modify `package.json` as follows:
23+
```diff
24+
- "proxy": "http://localhost:8080",
25+
+ "proxy": "https://algorithm-visualizer.org",
26+
```
1827
19-
3. Install dependencies, and run the web app.
28+
4. Install dependencies, and run the web app.
2029
2130
```bash
2231
cd algorithm-visualizer
@@ -26,7 +35,7 @@ Are you a first-timer in contributing to open source? [These guidelines](https:/
2635
npm start
2736
```
2837
29-
4. Open [`http://localhost:3000/`](http://localhost:3000/) in a web browser.
38+
5. Open [`http://localhost:3000/`](http://localhost:3000/) in a web browser.
3039
3140
## Directory Structure
3241

0 commit comments

Comments
 (0)