github-projects

Microservice to cache and expose GitHub projects for use throughout oceanprotocol.com.

API

Endpoint: https://oceanprotocol-github.now.sh

GET /

200: Returns a list of all public projects as follows

[
  {
    "name": "project-name",
    "description": "The description",
    "url": "https://github.com/oceanprotocol/project",
    "stars": 3040,
    "forks": 293,
    "isFork": false,
    "isArchived": false,
    "topics": [
      "oceanprotocol",
      "oceanprotocol-driver",
      "python"
    ]
  }
]

Development

Install dependencies:

npm install -g now
npm install

And run the server:

npm start

Test

Run the tests:

npm test

Deployment

Every branch is automatically deployed to Now 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 oceanprotocol-github.now.sh, configured as alias in now.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) - Ocean Protocol