mirror of
https://github.com/bigchaindb/github-projects.git
synced 2024-11-28 04:42:26 +01:00
88 lines
2.3 KiB
Markdown
88 lines
2.3 KiB
Markdown
# [](https://www.bigchaindb.com)
|
|
|
|
> Microservice to cache and expose GitHub projects for use throughout [www.bigchaindb.com](https://www.bigchaindb.com).
|
|
|
|
[](https://travis-ci.org/bigchaindb/github-projects)
|
|
[](https://github.com/sindresorhus/xo)
|
|
[](https://greenkeeper.io/)
|
|
<img src="http://forthebadge.com/images/badges/powered-by-electricity.svg" height="20"/>
|
|
<img src="http://forthebadge.com/images/badges/as-seen-on-tv.svg" height="20"/>
|
|
<img src="http://forthebadge.com/images/badges/uses-badges.svg" height="20"/>
|
|
|
|
## API
|
|
|
|
Endpoint: [`https://bigchaindb-github.now.sh`](https://bigchaindb-github.now.sh)
|
|
|
|
### GET /
|
|
|
|
**200**: Returns a list of all public projects as follows
|
|
|
|
```json
|
|
[
|
|
{
|
|
"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:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
And run the server:
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
## Test
|
|
|
|
Run the tests:
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
## Deployment
|
|
|
|
Every branch is automatically deployed to [Vercel](https://vercel.com) 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`](vercel.json).
|
|
|
|
### Manual Deployment
|
|
|
|
If needed, app can be deployed manually. Make sure to switch to Ocean Protocol org before deploying:
|
|
|
|
```bash
|
|
# first run
|
|
now login
|
|
now switch
|
|
|
|
# deploy
|
|
now
|
|
# switch alias to new deployment
|
|
now alias
|
|
```
|
|
|
|
## Authors
|
|
|
|
- Matthias Kretschmann ([@kremalicious](https://github.com/kremalicious)) - [BigchainDB](https://www.bigchaindb.com)
|
|
|
|
Blatantly ~~copied from~~ inspired by [zeit/github-projects](https://github.com/zeit/github-projects)
|