Microservice to cache and expose our GitHub projects. Beep boop.
Go to file
Matthias Kretschmann 3e536eae96
testing now-travis package
2017-06-07 16:15:50 +02:00
media it's a thing 2017-05-09 00:47:50 +02:00
test it's a thing 2017-05-09 00:47:50 +02:00
.editorconfig it's a thing 2017-05-09 00:47:50 +02:00
.gitignore it's a thing 2017-05-09 00:47:50 +02:00
.travis.yml testing now-travis package 2017-06-07 16:15:50 +02:00
index.js it's a thing 2017-05-09 00:47:50 +02:00
license.md it's a thing 2017-05-09 00:47:50 +02:00
package.json testing now-travis package 2017-06-07 16:15:50 +02:00
readme.md move badge around 2017-05-11 17:55:12 +02:00

readme.md

github-projects

Microservice to cache and expose GitHub projects for use throughout www.bigchaindb.com.

Build Status XO code style Greenkeeper badge

API

Endpoint: https://bigchaindb-github.now.sh

GET /

200: Returns a list of all public projects as follows

[
  {
    "name": "project-name",
    "description": "The description",
    "stars": 3040,
    "forks": 293,
    "is_fork": false,
    "release": "v0.10.0",
    "url": "https://github.com/bigchaindb/project"
  }
]

Development

Install dependencies:

npm install

And run the server:

npm start

Test

Run the tests:

npm test

Deployment

Deploy to now, make sure to switch to BigchainDB org before deploying:

# first run
now login
now switch

# deploy
now
# switch alias to new deployment, e.g.
now alias bigchaindb-github-projects-wxkyissxos bigchaindb-github

Authors

Blatantly copied from inspired by zeit/github-projects