You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
4. If you are using nvm, run `$ nvm use` to set your Node version to 16.14.2
17
+
4. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2
18
18
5. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g npm@8.5.0` to install it.
19
19
6. Navigate into the project folder and install all its necessary dependencies with npm.
20
20
@@ -27,12 +27,14 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
27
27
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
28
28
8.`$ cp .env.example .env`
29
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`
30
+
* See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github.
31
+
* See the [S3 Bucket Configuration](#s3-bucket-configuration) section for information on how to set up an S3 bucket
32
+
11. 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.
33
+
12. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
34
+
13.`$ npm start`
35
+
14. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
36
+
15. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
37
+
16. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w`
36
38
37
39
## Docker Installation
38
40
@@ -50,6 +52,8 @@ Note that this takes up a significant amount of space on your machine. Make sure
6. (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.
55
+
* See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github.
56
+
* See the [S3 Bucket Configuration](#s3-bucket-configuration) section for information on how to set up an S3 bucket
53
57
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
58
8. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
55
59
@@ -94,9 +98,15 @@ In this application, GitHub credentials are used for:
94
98
95
99
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.
96
100
97
-
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:
101
+
When you go to the (Developer settings)[https://github.com/settings/developers] 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:
0 commit comments