Giter Site home page Giter Site logo

get-gh-contributors's Introduction

get-gh-contributors

FOSSA Status

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  [email protected]:contributors (fetch)
deploy  [email protected]:contributors (push)
origin  [email protected]:ipfs/get-gh-contributors.git (fetch)
origin  [email protected]: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.

FOSSA Status

get-gh-contributors's People

Contributors

daviddias avatar fossabot avatar richardlitt avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.