Skip to content

Commit

Permalink
readme update for github oauth
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolocarpignoli committed Mar 18, 2024
1 parent 6e336f7 commit 5592fee
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ AR.js Studio is an authoring platform to build Web Augmented Reality experiences
## Try now!

🚀[Online version](https://ar-js-org.github.io/studio/)

[HacktoberFest page](https://ar-js-org.github.io/studio/hacktoberfest)

## Resources
Expand All @@ -19,13 +19,29 @@ AR.js Studio is an authoring platform to build Web Augmented Reality experiences
* [Design Mockup - only features, no real design](https://whimsical.com/D688LzTQQRyKESzRu1U4Au)
* [Meetings](https://docs.google.com/document/d/1ffUXGyd97phpInvrOiNEU-5WatO7tX_Yyu1AUVtq3T4/edit)

## If the publish on Github step fails

It is probably due to the external server handling oAuth2.0 requests.
We are using this project: https://github.com/prose/gatekeeper/ to handle the oAuth2.0 requests.
The project is now hosted on a private server, and it is not guaranteed to be always up and running.
If the publish fails, you should:

- fork the arjs studio project (because you need to change the `publish-confirm.js` file)
- host is somewhere else (even your GitHub pages)
- find a node server that can host the gatekeeper project
- set up the server with the gatekeeper project: you have to set, on the `config.json` file, the `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` [with the ones you get from the github oAuth app you create](https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api?apiVersion=2022-11-28)
- be aware that gatekeeper is listening on port 9999 by default, use that on your server
- on `studio` project, change the current URL on `publish-confirm.js` file line 21, with the new getekeeper server URL

All the other functionalities (and studio-backend project) should work as expected.

## Development

For maintaining a consistent code style while developing, please use
[Visual Studio Code](https://code.visualstudio.com/)

# Authors

Idea: [Nicolò Carpignoli](https://twitter.com/nicolocarp)
Idea: [Nicolò Carpignoli](https://twitter.com/nicolocarp)

Development: [AR.js Organisation](https://github.com/AR-js-org)

0 comments on commit 5592fee

Please sign in to comment.