mirror of
https://github.com/oceanprotocol/community-numbers.git
synced 2024-11-25 03:20:17 +01:00
2.9 KiB
2.9 KiB
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": {
"gitcoin": 1000,
"bountiesNetwork": 1000,
"total": 1000
},
"twitter": {
"followers": 1000
},
"telegram": {
"community": 1000,
"news": 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
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-community.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
License
Copyright 2018 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.