https://github.com/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://github.com/protofire/livepeer-alerts-frontend
Last synced: 12 months ago
JSON representation
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
- Host: GitHub
- URL: https://github.com/protofire/livepeer-alerts-frontend
- Owner: protofire
- License: mit
- Created: 2018-12-17T12:47:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-07T01:47:57.000Z (almost 4 years ago)
- Last Synced: 2023-04-10T04:54:30.854Z (about 3 years ago)
- Language: JavaScript
- Homepage: https://livepeer.tools
- Size: 11.6 MB
- Stars: 4
- Watchers: 8
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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
[](https://coveralls.io/github/protofire/livepeer-alerts-frontend?branch=master)
[](https://github.com/protofire/livepeer-alerts-frontend/issues)
[](https://raw.githubusercontent.com/protofire/livepeer-alerts-frontend/master/LICENSE)
### Demo
[Live version is worth thousand word](https://livepeer.tools/)
[](https://app.netlify.com/start/deploy?repository=https://github.com/protofire/livepeer-alerts-frontend)
## 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:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/)
### 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](https://github.com/protofire/livepeer-alerts-backend)
## Built With
* [React](https://reactjs.org/docs/getting-started.html) - The web framework used
* [NPM](https://www.npmjs.com/) - Dependency Management
* [Web3](https://web3js.readthedocs.io/en/1.0/) - Ethereum JavaScript API
* [Axios](https://github.com/axios/axios) - Promise based HTTP client for the browser and node.js
## Contributing
Please read [CONTRIBUTING.md](https://github.com/protofire/livepeer-alerts-frontend/blob/master/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](https://github.com/protofire/livepeer-alerts-frontend/blob/master/LICENSE) file for details