From 369963bc6e10e3712876a18b77a0a71d829dc3e9 Mon Sep 17 00:00:00 2001 From: Noah Lee Date: Fri, 24 May 2024 14:00:40 +0900 Subject: [PATCH] chore: Update CONTRIBUTING.md with authorization instructions --- CONTRIBUTING.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a73ee5bd..3e1862a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,8 +38,6 @@ GITPLOY_GITHUB_CLIENT_SECRET=XXXXXXXXXXXXX GITPLOY_STORE_SOURCE=file:./sqlite3.db?cache=shared&_fk=1 ``` -Note that if you want to interact with GitHub in the local environment, you should install tunneling tools such as [ngork](https://ngrok.com/) and expose your local server. - 3\. Run the server: ``` @@ -71,3 +69,22 @@ REACT_APP_GITPLOY_SERVER=http://localhost ``` npm start ``` + +### Authorization + +1\. Run with ngrok + +Connect to the public host via [ngrok](https://ngrok.com/) to authorize with GitHub OAuth. + +```shell +ngrok http 80 +``` + +2\. Configure GitHub OAuth Apps + +Configure the Homepage URL and Authorization callback URLs with the public host which generated by ngrok. + +3\. Access the index page + +Access the index page of server with the browser. You can find the user is created after authorization. +