mirror of
https://github.com/oceanprotocol/status
synced 2024-11-22 09:47:02 +01:00
137 lines
4.3 KiB
Markdown
137 lines
4.3 KiB
Markdown
[](https://oceanprotocol.com)
|
||
|
||
<h1 align="center">status</h1>
|
||
|
||
> 🐚 Overview and status checks of all Ocean Protocol RPC network connections. https://status.oceanprotocol.com
|
||
|
||
[](https://travis-ci.com/oceanprotocol/status)
|
||
[](https://codeclimate.com/github/oceanprotocol/status/maintainability)
|
||
[](https://codeclimate.com/github/oceanprotocol/status/test_coverage) [](https://greenkeeper.io/)
|
||
|
||
<a href="https://status.oceanprotocol.com"><img width="1373" alt="Status Interface" src="https://user-images.githubusercontent.com/90316/64959471-7ff30000-d891-11e9-84be-96151bb7ea2d.png"></a>
|
||
|
||
- [🦑 Features](#-features)
|
||
- [🏄 Get Started](#-get-started)
|
||
- [✨ Code Style](#-code-style)
|
||
- [👩🔬 Testing](#-testing)
|
||
- [🛳 Production](#-production)
|
||
- [⬆️ Deployment](#️-deployment)
|
||
- [Manual Deployment](#manual-deployment)
|
||
- [🎁 Contributing](#-contributing)
|
||
- [🏛 License](#-license)
|
||
|
||
## 🦑 Features
|
||
|
||
- Fetches and displays information for each of Ocean's remote RPC endpoints via [Parity JSON-RPC API](https://wiki.parity.io/JSONRPC) responses
|
||
- online/offline status (`eth_getBlockByNumber` & `parity_mode`)
|
||
- current block number (`eth_getBlockByNumber`)
|
||
- response time (custom `axios` interceptor)
|
||
- connected peers (`net_peerCount`)
|
||
- gas limit (`eth_getBlockByNumber`)
|
||
- gas price (`eth_gasPrice`)
|
||
- parity version (`web3_clientVersion`)
|
||
- current block number is linked to respective explorer
|
||
- automatically refetches all data every 5 sec.
|
||
- Gets network metadata from [@ethereum-navigator/atlas](https://github.com/ethereum-navigator/atlas)
|
||
|
||
## 🏄 Get Started
|
||
|
||
The app is a React app built with [Next.js](https://nextjs.org). To start local development:
|
||
|
||
```bash
|
||
git clone git@github.com:oceanprotocol/status.git
|
||
cd status
|
||
|
||
npm install
|
||
npm start
|
||
```
|
||
|
||
## ✨ Code Style
|
||
|
||
For linting and auto-formatting you can use from the root of the project:
|
||
|
||
```bash
|
||
# lint all js with eslint
|
||
npm run lint
|
||
|
||
# auto format all js & css with prettier, taking all configs into account
|
||
npm run format
|
||
```
|
||
|
||
## 👩🔬 Testing
|
||
|
||
Test suite is setup with [Jest](https://jestjs.io) and [react-testing-library](https://github.com/kentcdodds/react-testing-library) for unit testing.
|
||
|
||
To run all linting and unit tests:
|
||
|
||
```bash
|
||
npm test
|
||
```
|
||
|
||
For local development, you can start the test runner in a watch mode.
|
||
|
||
```bash
|
||
npm run test:watch
|
||
```
|
||
|
||
For analyzing the generated JavaScript bundle sizes you can use:
|
||
|
||
```bash
|
||
npm run analyze
|
||
```
|
||
|
||
## 🛳 Production
|
||
|
||
To create a production build, run from the root of the project:
|
||
|
||
```bash
|
||
npm run build
|
||
# serve production build
|
||
npm run serve
|
||
```
|
||
|
||
Outputs to `./public`.
|
||
|
||
## ⬆️ Deployment
|
||
|
||
Every branch or Pull Request is automatically deployed by [Now](https://zeit.co/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 `status.oceanprotocol.com`.
|
||
|
||
### Manual Deployment
|
||
|
||
If needed, app can be deployed manually. Make sure to switch to Ocean Protocol org before deploying:
|
||
|
||
```bash
|
||
# first run
|
||
now login
|
||
now switch
|
||
|
||
# deploy
|
||
now
|
||
# switch alias to new deployment
|
||
now alias
|
||
```
|
||
|
||
## 🎁 Contributing
|
||
|
||
See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation.
|
||
|
||
## 🏛 License
|
||
|
||
```text
|
||
Copyright 2019 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.
|
||
```
|