mirror of
https://github.com/bigchaindb/github-projects.git
synced 2024-11-21 17:36:53 +01:00
🤖 Microservice to cache and expose our GitHub projects. Beep boop.
6e5b64781c
Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.8.8 to 2.8.9. - [Release notes](https://github.com/npm/hosted-git-info/releases) - [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md) - [Commits](https://github.com/npm/hosted-git-info/compare/v2.8.8...v2.8.9) Signed-off-by: dependabot[bot] <support@github.com> |
||
---|---|---|
media | ||
.editorconfig | ||
.gitignore | ||
.travis.yml | ||
index.js | ||
license.md | ||
package-lock.json | ||
package.json | ||
readme.md | ||
vercel.json |
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",
"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
- Matthias Kretschmann (@kremalicious) - BigchainDB
Blatantly copied from inspired by zeit/github-projects