Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wejs/we-plugin-github

We.js plugin to consuming Github API
https://github.com/wejs/we-plugin-github

Last synced: about 1 month ago
JSON representation

We.js plugin to consuming Github API

Host: GitHub
URL: https://github.com/wejs/we-plugin-github
Owner: wejs
Created: 2015-08-20T20:21:32.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2022-01-22T10:14:22.000Z (almost 3 years ago)
Last Synced: 2024-04-08T09:07:22.298Z (9 months ago)
Language: JavaScript
Homepage: http://wejs.org/
Size: 36.1 KB
Stars: 4
Watchers: 9
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# We.js github plugin

We.js plugin to connect and consume github data with Github API

## Installation

```sh
we i we-plugin-github
```

## Has support:

- Authentication (Basic, Token, oAuth2)
- add one authenticated instance of github npm module in ```we.github```

### How to Setup (developer)

> after install npm and node.js

```js
// clone this project
git clone https://github.com/wejs/we-plugin-github.git
// enter in cloned folder
cd we-plugin-github
// install all dependencies
npm install
// test
npm test

// link
npm link
// enter in your project
cd [project folder]
// then link it in your project
npm link we-plugin-github
```

> add this config in you ```config/locals.js``` file and set the authentication configs

```js
// ...
github: {
debug: true, // enable logs
authentication: {
//
// // Example authentication configs
//
// //via token (Personal access token)
// type: 'token',
// token: ''
//
// // via username and password (do not recommend)
// type: 'basic',
// username: '',
// password: ''
//
// //via oauth2
// type: 'oauth',
// token: ''
},
expireDate: (60 * 60 * 60) // an hour
},
// ...
```