Skip to content

Commit ca2ef4e

Browse files
authored
Add more details for installation issues
1 parent 3a43d67 commit ca2ef4e

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

contributor_docs/installation.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ Before you dive in, note that there are two ways to install the project locally:
88

99
- **Docker Installation** is ideal if you want a faster setup with all dependencies (Node, MongoDB, etc.) isolated in containers. This avoids version conflicts and works consistently across environments especially helpful if you're new to backend setup or don't want to alter your local setup.
1010

11-
If you're just getting started, try going with the **Manual Installation** Method! Once you get comfortable, feel free to try out both and see which one you feel more comfortable with.
11+
If you're just getting started, try going with the **Manual Installation** method! Once you're comfortable with one method, feel free to try out both to see which one you prefer.
12+
13+
### Installation Issues
14+
If you run into any issues while setting up your environment, take some time to search through [prior issues](https://github.com/processing/p5.js-web-editor/issues) here or discussions on the [Processing Foundation discourse](https://discourse.processing.org/) to see if anyone has encountered what you've faced before. If you don't find anything, feel free to open one!
1215

1316
## Manual Installation
1417

1518
_Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
1619

17-
1. Install Node.js. The recommended way is to Node through [nvm](https://github.com/nvm-sh/nvm). You can also install [node.js](https://nodejs.org/download/release/v16.14.2/) version 16.14.2 directly from the Node.js website. To check if you already have Node installed on your computer, run `$ node -v`.
20+
1. Install Node.js. The recommended way is to Node through [nvm](https://github.com/nvm-sh/nvm), which is a command-line tool that helps you manage different versions of Node.js on your system. You can install nvm by using [nvm's installation guide](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating).
21+
- You can also install [node.js](https://nodejs.org/download/release/v16.14.2/) version 16.14.2 directly from the Node.js website. To check if you already have Node installed on your computer, run `$ node -v`.
1822
2. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account.
1923
3. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer.
2024

@@ -23,7 +27,7 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
2327
```
2428

2529
4. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2
26-
5. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g [email protected]` to install it.
30+
5. Ensure your npm version is set to 8.5.0 by running `$ npm -v`. If it isn't, run `npm install -g [email protected]` to install it.
2731
6. Navigate into the project folder and install all its necessary dependencies with npm.
2832

2933
```
@@ -37,7 +41,7 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
3741
9. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
3842
* See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github.
3943
* See the [S3 Bucket Configuration](#s3-bucket-configuration) section for information on how to set up an S3 bucket
40-
10. Run `$ npm run fetch-examples` to download the example sketches into a user called 'p5'. Note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section.
44+
10. (Optional) Run `$ npm run fetch-examples` to download the example sketches into a user called 'p5'. Note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section.
4145
11. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
4246
12. `$ npm start`
4347
13. Navigate to [http://localhost:8000](http://localhost:8000) in your browser

0 commit comments

Comments
 (0)