Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit 369963b

Browse files
committed
chore: Update CONTRIBUTING.md with authorization instructions
1 parent 232ac2d commit 369963b

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ GITPLOY_GITHUB_CLIENT_SECRET=XXXXXXXXXXXXX
3838
GITPLOY_STORE_SOURCE=file:./sqlite3.db?cache=shared&_fk=1
3939
```
4040

41-
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.
42-
4341
3\. Run the server:
4442

4543
```
@@ -71,3 +69,22 @@ REACT_APP_GITPLOY_SERVER=http://localhost
7169
```
7270
npm start
7371
```
72+
73+
### Authorization
74+
75+
1\. Run with ngrok
76+
77+
Connect to the public host via [ngrok](https://ngrok.com/) to authorize with GitHub OAuth.
78+
79+
```shell
80+
ngrok http 80
81+
```
82+
83+
2\. Configure GitHub OAuth Apps
84+
85+
Configure the Homepage URL and Authorization callback URLs with the public host which generated by ngrok.
86+
87+
3\. Access the index page
88+
89+
Access the index page of server with the browser. You can find the user is created after authorization.
90+

0 commit comments

Comments
 (0)