Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olivierjm/powercut
This is a little project to track Zesco Load shedding, used by over 15k visitors
https://github.com/olivierjm/powercut
Last synced: 12 days ago
JSON representation
This is a little project to track Zesco Load shedding, used by over 15k visitors
- Host: GitHub
- URL: https://github.com/olivierjm/powercut
- Owner: OlivierJM
- License: mit
- Created: 2024-03-11T17:06:41.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-30T07:35:08.000Z (about 1 month ago)
- Last Synced: 2024-10-15T03:49:32.182Z (25 days ago)
- Language: TypeScript
- Homepage: https://powercut.app
- Size: 1.38 MB
- Stars: 18
- Watchers: 3
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Powercut
Easier way to track load shedding schedule in Zambia
## Demo
https://powercut.app
## Table of Contents
- [Overview]()
- [How does it work](#how-does-it-work)
- [Installation](#installation)
- [Features](#features)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
- [Contact](#contact)
- [Acknowledgments](#acknowledgments)
## Overview
Recently in Zambia, we've experienced load shedding, currently at stage 1, resulting in 8 hours per day without electricity across various areas. It can be challenging to anticipate these power outages, making it difficult to plan ahead for activities such as ironing your clothes. This project is designed to provide clear visibility into the load shedding schedule, helping you understand and plan for these outages more easily.
## How does it work
The tricky part of getting this to work was cleaning the data from zesco and making sure it is in a good shape to work with.
So we get data from the pdf extract areas and schedules, clean it with different tools and make sure it is proper JSON. For better user experience we make it easy for users to find areas that are supported by offering them autocompletion, After we get the user's area we find the group they are in within a specific province and then we find the schedule for that Group and then we show all upcoming schedule for that Group.
## Installation
Steps to install your project.
```bash
git clone https://github.com/olivierjm/powercut.git
cd powercut
yarn
yarn run dev
```
## Schedule Updates
When ZESCO updates the loadshedding schedules you'll be required to run the following `schedule-parse` script to in order update the `./src/data/schedule.json` file.
You can use the `./schedule-example.json` to test how this script works.
```bash
yarn schedule-parse [filePath]
✨ Schedule successfully updated. Happy coding! ✨
```
## Features
- Shows upcoming schedule for an area
- Supports Lusaka, Copperbelt & North Western Province
- Works offline
- Installable on devices
## 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/amazing-feature`)
3. Commit your Changes (`git commit -m 'Add some amazing-feature'`)
4. Push to the Branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
Note: Make sure all tests are passing and if you add new change add accompanying tests. (`yarn test`)
## Code of Conduct
Please adhere to this project's [code of conduct](CODE_OF_CONDUCT.md).
## License
Distributed under the MIT License. See [License](LICENSE.md) for more information.
## Contact
OlivierJM - [email protected]
## Acknowledgments
- Thanks to Zesco for making the schedule public