mirror of https://github.com/oceanprotocol/community-numbers.git synced 2024-11-21 17:27:01 +01:00

🤖 Microservice to cache and expose community numbers. Beep boop.

Go to file

dependabot[bot] e150a67ba9 Bump eslint from 7.21.0 to 7.27.0 (#67 ) Bumps [eslint](https://github.com/eslint/eslint) from 7.21.0 to 7.27.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v7.21.0...v7.27.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2021-05-25 08:09:26 +02:00
.github	fixes & formatting	2020-06-16 12:32:47 +02:00
api	update comments	2021-02-04 13:15:41 +02:00
.eslintrc	fixes & formatting	2020-06-16 12:32:47 +02:00
.gitignore	discord tinkering	2020-06-11 15:32:41 +02:00
.prettierrc	fixes & formatting	2020-06-16 12:32:47 +02:00
.travis.yml	fixes & formatting	2020-06-16 12:32:47 +02:00
LICENSE	initial commit 🐚	2019-05-14 20:52:48 +02:00
package-lock.json	Bump eslint from 7.21.0 to 7.27.0 (#67 )	2021-05-25 08:09:26 +02:00
package.json	Bump eslint from 7.21.0 to 7.27.0 (#67 )	2021-05-25 08:09:26 +02:00
README.md	update docs	2021-02-04 14:00:06 +01:00
vercel.json	fixes & formatting	2020-06-16 12:32:47 +02:00

README.md

community-numbers

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

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": {
    "open": 1000,
    "total": 1000
  },
  "twitter": {
    "followers": 1000
  },
  "telegram": {
    "community": 1000,
    "news": 1000
  },
  "discord": {
    "members": 1000
  }
}

Development

Install dependencies:

npm install -g vercel
npm install

And run the server in dev mode:

npm start

Then either open up http://localhost:3000 in a browser or do in another Terminal:

curl http://localhost:3000

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 main branch is automatically aliased to oceanprotocol-community.now.sh.

Manual Deployment

If needed, app can be deployed manually. Make sure to switch to Ocean Protocol org before deploying:

# first run
vercel login
vercel switch

# deploy
vercel
# switch alias to new deployment
vercel alias

License

Copyright 2021 Ocean Protocol Foundation Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.