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.
|
||
---|---|---|
.github | ||
api | ||
.eslintrc | ||
.gitignore | ||
.prettierrc | ||
.travis.yml | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
vercel.json |
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.