Skip to content

Commit a8cc207

Browse files
authored
Merge pull request processing#2069 from raclim/raclim/contributor-documentation-updates
update manual and docker installation documentation
2 parents a4a5742 + b5d5047 commit a8cc207

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

contributor_docs/installation.md

+24-22
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,24 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
1515
```
1616

1717
4. If you are using nvm, run `$ nvm use` to set your Node version to 16.14.2
18-
5. Navigate into the project folder and install all its necessary dependencies with npm.
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.
1920

2021
```
2122
$ cd p5.js-web-editor
2223
$ npm install
2324
```
24-
6. Install MongoDB and make sure it is running
25+
7. Install MongoDB and make sure it is running
2526
* 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/)
2627
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
27-
7. `$ cp .env.example .env`
28-
8. (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.
29-
9. 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.
30-
10. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
31-
11. `$ npm start`
32-
12. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
33-
13. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
34-
14. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w`
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+
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.
31+
11. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
32+
12. `$ npm start`
33+
13. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
34+
14. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
35+
15. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w`
3536

3637
## Docker Installation
3738

@@ -42,27 +43,28 @@ Using Docker, you can have a complete, consistent development environment withou
4243
Note that this takes up a significant amount of space on your machine. Make sure you have at least 5GB free.
4344

4445
1. Install Docker for your operating system
45-
* Mac: https://www.docker.com/docker-mac
46-
* Windows: https://www.docker.com/docker-windows
47-
2. Clone this repository and cd into it
48-
3. `$ docker-compose -f docker-compose-development.yml build`
49-
4. `$ cp .env.example .env`
50-
5. (Optional) Update `.env` with necessary keys to enable certain app behavoirs, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
51-
6. `$ docker-compose -f docker-compose-development.yml run --rm app npm run fetch-examples` - note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section.
52-
7. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
46+
* [Mac](https://www.docker.com/docker-mac)
47+
* [Windows](https://www.docker.com/docker-windows)
48+
2. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
49+
3. Clone this repository and cd into it
50+
4. `$ docker-compose -f docker-compose-development.yml build`
51+
5. `$ cp .env.example .env`
52+
6. (Optional) Update `.env` with necessary keys to enable certain app behavoirs, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
53+
7. `$ docker-compose -f docker-compose-development.yml run --rm app npm run fetch-examples` - note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section.
54+
8. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
5355

5456
Now, anytime you wish to start the server with its dependencies, you can run:
5557

56-
8. `$ docker-compose -f docker-compose-development.yml up`
57-
9. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
58+
9. `$ docker-compose -f docker-compose-development.yml up`
59+
10. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
5860

5961
To open a terminal/shell in the running Docker server (i.e. after `docker-compose up` has been run):
6062

61-
10. `$ docker-compose -f docker-compose-development.yml exec app bash -l`
63+
11. `$ docker-compose -f docker-compose-development.yml exec app bash -l`
6264

6365
If you don't have the full server environment running, you can launch a one-off container instance (and have it automatically deleted after you're done using it):
6466

65-
11. `$ docker-compose -f docker-compose-development.yml run app --rm bash -l`
67+
12. `$ docker-compose -f docker-compose-development.yml run app --rm bash -l`
6668

6769
## S3 Bucket Configuration
6870

0 commit comments

Comments
 (0)