Skip to content

Commit 182b60a

Browse files
committed
update the installation doc with github api configuration section linked to manual and docker installation
1 parent 5527ebd commit 182b60a

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

developer_docs/installation.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
2626
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
2727
7. `$ cp .env.example .env`
2828
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. `$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
29+
9. `$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'. Note that you need to configure your Github API, details can be found in the [Github API Configuration] section(https://github.com/vulongphan/p5.js-web-editor/blob/fix/installation-guide-update/developer_docs/installation.md#github-api-configuration)
3030
10. `$ npm start`
3131
11. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
3232
12. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
@@ -47,7 +47,7 @@ Note that this takes up a significant amount of space on your machine. Make sure
4747
3. `$ docker-compose -f docker-compose-development.yml build`
4848
4. `$ cp .env.example .env`
4949
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.
50-
6. `$ docker-compose -f docker-compose-development.yml run --rm app npm run fetch-examples`
50+
6. `$ docker-compose -f docker-compose-development.yml run --rm app npm run fetch-examples` - note that you need to configure your Github API, details can be found in the [Github API Configuration] section(https://github.com/vulongphan/p5.js-web-editor/blob/fix/installation-guide-update/developer_docs/installation.md#github-api-configuration)
5151

5252
Now, anytime you wish to start the server with its dependencies, you can run:
5353

@@ -83,8 +83,6 @@ http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostin
8383

8484
## Github API Configuration
8585

86-
This is neccessary for step 9 in [Manual Installation](https://github.com/processing/p5.js-web-editor/blob/develop/developer_docs/installation.md#manual-installation) section and step 6 in [Docker Installation](https://github.com/processing/p5.js-web-editor/blob/6a6eeb21ef386c30a81ca6172b4557a4c92f5223/developer_docs/installation.md#docker-installation) section
87-
8886
In this application, Github Credentials are used for:
8987
* Authentication with GitHub
9088
* Importing the p5.js examples to your local database

0 commit comments

Comments
 (0)