Skip to content

Commit c97ef30

Browse files
committed
update the installation doc with github api configuration section linked to manual and docker installation
1 parent d1f5de4 commit c97ef30

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

developer_docs/installation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ _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. Run `$ npm run fetch-examples` to download 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](https://github.com/vulongphan/p5.js-web-editor/blob/fix/installation-guide-update/developer_docs/installation.md#github-api-configuration) section
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+
3031
10. `$ npm start`
3132
11. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
3233
12. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
@@ -47,7 +48,8 @@ Note that this takes up a significant amount of space on your machine. Make sure
4748
3. `$ docker-compose -f docker-compose-development.yml build`
4849
4. `$ cp .env.example .env`
4950
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` - note that you need to configure your Github API, details can be found in the [Github API Configuration](https://github.com/vulongphan/p5.js-web-editor/blob/fix/installation-guide-update/developer_docs/installation.md#github-api-configuration) section
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+
5153

5254
Now, anytime you wish to start the server with its dependencies, you can run:
5355

0 commit comments

Comments
 (0)