status-frontend/README.md

status-frontend

Frontend client for showing the status of Ocean Protocol services.

• 🦑 Features
• 🏄 Get Started
• ✨ Code Style
• 🛳 Production
• ⬆️ Deployment
• 🏛 License

🦑 Features

• Fetches and displays information for each of Ocean's remote components, grouped by network
• fetched from https://status-api.oceanprotocol.com, which is built with:
  • oceanprotocol/status-api
  • oceanprotocol/status-monitoring-service

🏄 Get Started

The app is a React app built with Next.js. To start local development:

git clone git@github.com:oceanprotocol/status-frontend.git
cd status

npm install
cp .env.example .env
npm run dev

Open http://localhost:3000 with your browser to see the result.

✨ Code Style

For linting checks you can use from the root of the project:

# lint all js with eslint
npm run lint

🛳 Production

To create a production build, run from the root of the project:

npm run build

Outputs to ./next.

⬆️ Deployment

Every branch or Pull Request is automatically deployed by Netlify with their GitHub integration. A link to a deployment will appear under each Pull Request.

🏛 License

Copyright ((C)) 2022 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.