GitHub OAuth App

Vssue can also work with self-hosted GitHub Enterprise Server. Set the baseURL options to your Github URL. See Options Reference - baseURL

GitHub requires clientSecret because GitHub does not support implicit grant type Set up OAuth App - Github 00

Create a new OAuth App

Set up OAuth App - Github 01
Set up OAuth App - Github 02
Set up OAuth App - Github 03

  • Set the Homepage URL and Authorization callback URL to your website URL (Here we take localhost:8080 for example)

Set up OAuth App - Github 04

Get the Client ID and Secret

Then you've created a new OAuth App, and here is your Client ID and Client Secret.

Set up OAuth App - Github 05

Config and start your Vssue

Copy the Client ID and Client Secret, and set owner and repo.

The URL pattern of github repo is https://github.com/${owner}/${repo}

Here we take https://github.com/meteorlxy/vssue-demo for example, and set the title of issue to Vssue Demo.

Then run anywhere -h localhost 8080 to serve the index.html on localhost:8080.

Set up OAuth App - Github 06

Try out Vssue locally

Vssue has already run here. Click Login to login with github account.

Set up OAuth App - Github 07

Redirect to Github Authorization page. Click Authorize ${your account} to login.

Set up OAuth App - Github 08

Leave a comment on this page ~

Set up OAuth App - Github 09

Set up OAuth App - Github 10

You can go to the repo meteorlxy/vssue-demo to get the demo code. Check the #1 issue of that repo to see what happened.