https://github.com/wazeerc/popn
An application that allows you to view when there is going to be a power outage in a specific (user defined) region of Mauritius.
https://github.com/wazeerc/popn
electricity mauritius nodejs opendata
Last synced: 4 months ago
JSON representation
An application that allows you to view when there is going to be a power outage in a specific (user defined) region of Mauritius.
- Host: GitHub
- URL: https://github.com/wazeerc/popn
- Owner: wazeerc
- License: mit
- Created: 2023-01-12T16:26:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-16T13:10:15.000Z (over 1 year ago)
- Last Synced: 2024-10-12T02:28:24.397Z (12 months ago)
- Topics: electricity, mauritius, nodejs, opendata
- Language: JavaScript
- Homepage:
- Size: 2.58 MB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Power Outage Push Notifications 🔌🇲🇺
### About The Project
A Node.js application that allows the user to look up when the next planned power outage of their locality will occur.
The application pulls data from [CEB](https://ceb.mu/customer-corner/power-outage-information) via this [dataset](https://github.com/MrSunshyne/mauritius-dataset-electricity).
###### Note: Current state of the app only serves to query the dataset, push notification features are under development 🚧
#### Built with;
[![Node][Node.js]][Node-url]
[![npm][npm]][npm-url]
[![electricity][electricity]][electricity-url]
# Getting Started
## Prerequisites
Download Node on your machine from [here](https://nodejs.org/en/download/) and install the required NPM packages;
```
npm i express node-fetch
```
Clone the repo;
```sh
git clone https://github.com/wazeerc/popn
```
Start the node server within the project directory;
```sh
npm run start
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again! 😁
1. Fork the Project
2. Create your Feature Branch `git checkout -b feature/AmazingFeature`
3. Commit your Changes `git commit -m 'Add some AmazingFeature'`
4. Push to the Branch `git push origin feature/AmazingFeature`
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
---
### Disclaimer 🚨
Not affiliated with CEB in any way. This is a personal project and is not endorsed by CEB. Data is fetched from the above mentionned dataset but not directly from CEB.
[Node.js]: https://img.shields.io/badge/node.js-000000?style=for-the-badge&logo=nodedotjs&logoColor=white
[Node-url]: https://nodejs.org/
[npm]: https://img.shields.io/badge/npm-000000?style=for-the-badge&logo=npm&logoColor=white
[npm-url]: https://www.npmjs.com/
[electricity]: https://img.shields.io/badge/%E2%9A%A1-000000?style=for-the-badge&logo=power&logoColor=white
[electricity-url]: https://