1
0
mirror of https://github.com/bigchaindb/github-projects.git synced 2024-06-19 11:03:19 +02:00
Microservice to cache and expose our GitHub projects. Beep boop.
Go to file
2018-04-10 14:51:03 +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 add release url to bigchaindb 2018-04-10 14:46:51 +02:00
.travis.yml Travis fixes 2017-05-09 01:51:34 +02:00
index.js add release url to bigchaindb 2018-04-10 14:46:51 +02:00
license.md it's a thing 2017-05-09 00:47:50 +02:00
package.json update all the things 2018-04-10 14:49:47 +02:00
readme.md update docs 2018-04-10 14:51:03 +02:00

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",
    "release_url": "https://github.com/bigchaindb/bigchaindb/releases/tag/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

Blatantly copied from inspired by zeit/github-projects