0.0.1 • Published 5 years ago

auth-routes v0.0.1

Weekly downloads
11
License
ISC
Repository
github
Last release
5 years ago

Usage

const { registerAuthRoutes } = require('auth-routes')

const app = express()
registerAuthRoutes(app, {
  client_id: process.env.GITHUB_CLIENT_ID,
  client_secret: process.env.GITHUB_CLIENT_SECRET
})

// Or pass some options:
registerAuthRoutes(app, {
  loginURL: '/log-me-in',
  callbackURL: '/call-me-back',
  client_id: process.env.GITHUB_CLIENT_ID,
  client_secret: process.env.GITHUB_CLIENT_SECRET
})

Use with Probot

module.exports = app => {
  // Access the Express server that Probot uses
  const expressApp = app.route()

  // Register the routes as normal
  registerAuthRoutes(expressApp, {
    client_id: process.env.GITHUB_CLIENT_ID,
    client_secret: process.env.GITHUB_CLIENT_SECRET
  })
}

Options

NameDescriptionRequiredDefault
client_idGitHub App's Client ID-
client_secretGitHub App's Client Secret-
loginURLLogin path'/login'
callbackURLAuthorization callback URL, for your GitHub App'/login/cb'
afterLoginWhere users are redirected to after they've logged in'/'