bigchaindb
/
github-projects
mirror of https://github.com/bigchaindb/github-projects.git
1
0
Fork 0
Code Releases Activity
github-projects/readme.md

1.7 KiB
Executable File
Raw Blame History

github-projects

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

Build Status XO code style

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

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