Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 2.61 KB

README.md

File metadata and controls

85 lines (55 loc) · 2.61 KB
Raw

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 via this dataset.

Note: Current state of the app only serves to query the dataset, push notification features are under development 🚧

Built with;

Node npm electricity

Getting Started

Prerequisites

Download Node on your machine from here and install the required NPM packages;

npm i express node-fetch

Clone the repo;

git clone https://github.com/wazeerc/popn

Start the node server within the project directory;

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.

☝️