get-gh-contributors

Fetch and serve our users and contributors data from github

Install

> npm install

Usage

> node src/fetch.js
# will create a folder named data

API

> npm start
# starts an API on port 9090 by default (change with `PORT=<somePortNumber> npm start`)

Endpoints

/contributors?photo=<bool>&url=<bool>&username<bool>&org=<nameOfTheorg>&page=<number>

Returns a JSON blob containing the information about the users for a certain org.

Defaults:

• photo: true
• url: true
• username: true
• org: all. Other options: ipld, multiformats, ipfs, libp2p, orbitdb.
• page: pagination, sends arrays of 100 contributors at a time, if no value is passed, all of them are sent.

Deploy

Make sure to have the dokku endpoint as one of your git remote

> git remote -v
deploy  dokku@cloud.ipfs.team:contributors (fetch)
deploy  dokku@cloud.ipfs.team:contributors (push)
origin  git@github.com:ipfs/get-gh-contributors.git (fetch)
origin  git@github.com:ipfs/get-gh-contributors.git (push)

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to IPFS are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2017 Protocol Labs Inc.