github-projects/readme.md

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

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",
    "topics": [
      "bigchaindb",
      "bigchaindb-driver",
      "python"
    ]
  }
]

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
now alias

Authors

• Matthias Kretschmann (@kremalicious) - BigchainDB

Blatantly copied from inspired by zeit/github-projects