https://github.com/eggjs/egg-passport-github
github passport plugin for egg
https://github.com/eggjs/egg-passport-github
egg-passport egg-plugin passport-github
Last synced: about 1 month ago
JSON representation
github passport plugin for egg
- Host: GitHub
- URL: https://github.com/eggjs/egg-passport-github
- Owner: eggjs
- License: mit
- Created: 2017-02-16T16:37:50.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T06:20:11.000Z (about 3 years ago)
- Last Synced: 2025-09-10T20:49:15.928Z (6 months ago)
- Topics: egg-passport, egg-plugin, passport-github
- Language: JavaScript
- Size: 9.77 KB
- Stars: 10
- Watchers: 8
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# egg-passport-github
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-passport-github.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-passport-github
[travis-image]: https://img.shields.io/travis/eggjs/egg-passport-github.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-passport-github
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-passport-github.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-passport-github?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-passport-github.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-passport-github
[snyk-image]: https://snyk.io/test/npm/egg-passport-github/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-passport-github
[download-image]: https://img.shields.io/npm/dm/egg-passport-github.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-passport-github
github passport plugin for egg
## Install
```bash
$ npm i egg-passport-github --save
```
## Usage
```js
// config/plugin.js
exports.passportGithub = {
enable: true,
package: 'egg-passport-github',
};
```
## Configuration
```js
// config/config.default.js
exports.passportGithub = {
key: 'your oauth key',
secret: 'your oauth secret',
};
```
see [config/config.default.js](config/config.default.js) for more detail.
## Questions & Suggestions
Please open an issue [here](https://github.com/eggjs/egg/issues).
## License
[MIT](LICENSE.txt)