bigchaindb
/
github-projects
mirror of https://github.com/bigchaindb/github-projects.git
1
0
Fork 0
Code Releases Activity
🤖 Microservice to cache and expose our GitHub projects. Beep boop.
67 Commits 12 Branches 0 Tags 284 KiB
JavaScript 100%
Go to file
Matthias Kretschmann e8913a8ec5
Merge pull request #35 from bigchaindb/greenkeeper/xo-0.20.2 
chore(package): update xo to version 0.20.2
 		2018-02-15 18:15:41 +01: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 Travis fixes 2017-05-09 01:51:34 +02:00
index.js lint fix 2018-02-15 18:07:33 +01:00
license.md 🎭 it's a thing 2017-05-09 00:47:50 +02:00
package.json Merge pull request #35 from bigchaindb/greenkeeper/xo-0.20.2 2018-02-15 18:15:41 +01:00
readme.md add topics to example 2017-06-28 20:19:42 +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",
    "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