Merge pull request #1678 from vulongphan/fix/installation-guide-update

Update installation doc regarding Github API configuration

Author: catarak

developer_docs/installation.md

@@ -26,7 +26,8 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
    * For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
 7. `$ cp .env.example .env`
 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.
-9. `$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
+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.
+
 10. `$ npm start`
 11. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
 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
 3. `$ docker-compose -f docker-compose-development.yml build`
 4. `$ cp .env.example .env`
 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.
-6. `$ docker-compose -f docker-compose-development.yml run --rm app npm run fetch-examples`
+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.
+
 
 Now, anytime you wish to start the server with its dependencies, you can run:
 
@@ -80,3 +82,19 @@ name, you can also set it using this variable. I.e.:
 For more information on using a custom domain, see this documentation link:
 
 http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingCustomURLs
+
+## GitHub API Configuration
+
+In this application, GitHub credentials are used for:
+* Authentication with GitHub
+* Importing the p5.js examples to your local database
+* Rendering the 404 pages
+
+If you are working on a part of the application that requires one of the above uses, then you will need to get GitHub API credentials.
+
+When you go to the Developer settings in your GitHub account, you will see that you can create two types of Apps: `GitHub Apps` and `OAuth Apps` ([differences between GitHub Apps and OAuth Apps](https://docs.github.com/en/free-pro-team@latest/developers/apps/differences-between-github-apps-and-oauth-apps)). This project requires you to make an `OAuth App`. After clicking on "New OAuth App", you will need to fill in the following fields:
+- **Application name**: `p5.js Web Editor - Local`
+- **Homepage URL**: `http://localhost:8000`
+- **Authorization Callback URL**: `http://localhost:8000/auth/github/callback`
+
+If you would like to learn more about what you can do with the GitHub API, you can look at the [API documentation](https://developer.github.com/v3/).