🤖 Microservice to cache and expose our GitHub projects. Beep boop.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
dependabot[bot] c147fdc96b
Bump normalize-url from 4.5.0 to 4.5.1 (#68)
1 year ago
media 🎭 it's a thing 5 years ago
.editorconfig 🎭 it's a thing 5 years ago
.gitignore refactor & cleanup 2 years ago
.travis.yml Travis fixes 5 years ago
index.js refactor & cleanup 2 years ago
license.md 🎭 it's a thing 5 years ago
package-lock.json Bump normalize-url from 4.5.0 to 4.5.1 (#68) 1 year ago
package.json refactor & cleanup 2 years ago
readme.md refactor & cleanup 2 years ago
vercel.json refactor & cleanup 2 years ago

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