https://github.com/bigchaindb/github-projects

🤖 Microservice to cache and expose our GitHub projects. Beep boop.
https://github.com/bigchaindb/github-projects

json microservice nodejs

Last synced: 3 months ago
JSON representation

🤖 Microservice to cache and expose our GitHub projects. Beep boop.

• Host: GitHub
• URL: https://github.com/bigchaindb/github-projects
• Owner: bigchaindb
• License: mit
• Created: 2017-05-08T23:13:08.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T08:04:28.000Z (about 2 years ago)
• Last Synced: 2024-04-14T21:52:32.688Z (10 months ago)
• Topics: json, microservice, nodejs
• Language: JavaScript
• Homepage: https://www.bigchaindb.com
• Size: 273 KB
• Stars: 7
• Watchers: 4
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# [![github-projects](media/[email protected])](https://www.bigchaindb.com)

> Microservice to cache and expose GitHub projects for use throughout [www.bigchaindb.com](https://www.bigchaindb.com).

[![Build Status](https://travis-ci.org/bigchaindb/github-projects.svg?branch=master)](https://travis-ci.org/bigchaindb/github-projects)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

[![Greenkeeper badge](https://badges.greenkeeper.io/bigchaindb/github-projects.svg)](https://greenkeeper.io/)







## 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)