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
Copy file name to clipboardExpand all lines: contributor_docs/installation.md
+14-14
Original file line number
Diff line number
Diff line change
@@ -7,34 +7,34 @@ Follow these instructions to set up your development environment, which you need
7
7
_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`.
8
8
9
9
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`.
10
-
3.[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.
11
-
4.[Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer.
10
+
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.
11
+
3.[Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer.
5. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2
18
-
6. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g [email protected]` to install it.
19
-
7. Navigate into the project folder and install all its necessary dependencies with npm.
17
+
4. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2
18
+
5. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g [email protected]` to install it.
19
+
6. Navigate into the project folder and install all its necessary dependencies with npm.
20
20
21
21
```
22
22
$ cd p5.js-web-editor
23
23
$ npm install
24
24
```
25
-
8. Install MongoDB and make sure it is running
25
+
7. Install MongoDB and make sure it is running
26
26
* For Mac OSX with [homebrew](http://brew.sh/): `brew tap mongodb/brew` then `brew install mongodb-community` and finally start the server with `brew services start mongodb-community` or you can visit the installation guide here [Installation Guide For MacOS](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/)
27
27
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
28
-
9.`$ cp .env.example .env`
29
-
10. (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.
28
+
8.`$ cp .env.example .env`
29
+
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.
30
30
* See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github.
31
31
* See the [S3 Bucket Configuration](#s3-bucket-configuration) section for information on how to set up an S3 bucket
32
-
11. 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.
33
-
12. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
34
-
13.`$ npm start`
35
-
14. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
36
-
15. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
37
-
16. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w`
32
+
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.
33
+
11. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
34
+
12.`$ npm start`
35
+
13. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
36
+
14. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
37
+
15. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w`
0 commit comments