Skip to content

Commit 94ae6a7

Browse files
committed
[#1679] Update GitHub API credentials documentation
1 parent c97ef30 commit 94ae6a7

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

developer_docs/installation.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,18 @@ For more information on using a custom domain, see this documentation link:
8383

8484
http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingCustomURLs
8585

86-
## Github API Configuration
86+
## GitHub API Configuration
8787

88-
In this application, Github Credentials are used for:
88+
In this application, GitHub credentials are used for:
8989
* Authentication with GitHub
9090
* Importing the p5.js examples to your local database
9191
* Rendering the 404 pages
9292

93-
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.
93+
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.
9494

95-
An overview about Github API can be found [here](https://developer.github.com/v3/).
96-
97-
When you go to your Developers Settings, you will see two types of Apps `Github Apps` and `OAuth Apps`. For this application, you should create an OAuth App since some Github API calls will not accept your Credentials if you create a Github App. One of the key differences between the two is that while `Oauth Apps` act on your behalf, `Github Apps` act on its own. More differences between these two can be found [here](https://docs.github.com/en/free-pro-team@latest/developers/apps/differences-between-github-apps-and-oauth-apps)
95+
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:
96+
- **Application name**: `p5.js Web Editor - Local`
97+
- **Homepage URL**: `http://localhost:8000`
98+
- **Authorization Callback URL**: `http://localhost:8000/auth/github/callback`
9899

100+
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/).

0 commit comments

Comments
 (0)