community-numbers/README.md

1.9 KiB

banner

community-numbers

Microservice to cache and expose community numbers for use throughout oceanprotocol.com.

Build Status js oceanprotocol Greenkeeper badge

API

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

GET /

200: Returns a list of network numbers as follows:

{
    "github": {
        "stars": 1000,
        "repos": 1000
    },
    "medium": {
        "followers": 1000
    },
    "bounties": {
        "gitcoin": 1000,
        "bountiesNetwork": 1000,
        "total": 1000
    },
    "twitter": {
        "followers": 1000
    }
}

Development

Install dependencies:

npm install -g now
npm install

And run the server in dev mode:

npm start

Test

Run the tests:

npm test

Deployment

Deploy to now, 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