Microservice to cache and expose our GitHub projects. Beep boop.
 
Go to file
dependabot[bot] c147fdc96b
Bump normalize-url from 4.5.0 to 4.5.1 (#68)
Bumps [normalize-url](https://github.com/sindresorhus/normalize-url) from 4.5.0 to 4.5.1.
- [Release notes](https://github.com/sindresorhus/normalize-url/releases)
- [Commits](https://github.com/sindresorhus/normalize-url/commits)

---
updated-dependencies:
- dependency-name: normalize-url
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-14 14:51:39 +02:00
media 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 refactor & cleanup 2020-05-30 03:41:32 +02:00
.travis.yml Travis fixes 2017-05-09 01:51:34 +02:00
index.js refactor & cleanup 2020-05-30 03:41:32 +02:00
license.md it's a thing 2017-05-09 00:47:50 +02:00
package-lock.json Bump normalize-url from 4.5.0 to 4.5.1 (#68) 2021-06-14 14:51:39 +02:00
package.json refactor & cleanup 2020-05-30 03:41:32 +02:00
readme.md refactor & cleanup 2020-05-30 03:41:32 +02:00
vercel.json refactor & cleanup 2020-05-30 03:41:32 +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",
    "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

Every branch is automatically deployed to Vercel with their GitHub integration. A link to a deployment will appear under each Pull Request.

The latest deployment of the master branch is automatically aliased to bigchaindb-github.now.sh, configured as alias in vercel.json.

Manual Deployment

If needed, app can be deployed manually. Make sure to switch to Ocean Protocol 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