protofire / livepeer-alerts-frontend

Provide pro-active alert notifications that will help LPT token holders to be updated and understand how the transcoders they are delegating the tokens to are performing in near real time
https://livepeer.tools
MIT License
4 stars 2 forks source link

Livepeer Notifications

Provide pro-active alert notifications that will help LPT token holders to be updated and understand how the transcoders they are delegating the tokens to are performing in near real time

Coverage Status contributions welcome MIT licensed

Demo

Live version is worth thousand word

Deploy to Netlify

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

In order to develop livepeer-alerts-frontend, you'll need:

Installing

Clone this repository and install npm dependencies:

1) git clone git@github.com:protofire/livepeer-alerts-frontend.git
2) cd livepeer-alerts-frontend
3) npm install
4) Copy ".env.example" and rename it as ".env"
5) Edit your enviroment variables with your default api URL and the production mode (development/production)
6) npm start
7) Your development env will be running on "http://localhost:4040/" or in the url you defined on the .ENV file

Running the tests

1) On the project folder run "npm test"

Deployment

If you want to deploy the project on heroku for example, once you finished the heroku configuration you need to put the deployment URL on the .ENV file as explained in the installation step

Backend

You can take a look at the backend right here

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE file for details