Skip to content

A chrome extension that utilizes the Eskom Se Push Loadshedding APIs. Stay informed about load shedding schedules in South Africa.

License

Notifications You must be signed in to change notification settings

CellectIO/ZparkWise

Repository files navigation

ZparkWise Logo Image

ZparkWise SA Loadshedding Chrome Extension

ZparkWise Promo Image


⚠️ Disclaimer

This project is completely independent and has no affiliation, endorsement, or partnership with WellWellWell Investments (Pty) Ltd ("ESP").

🚨 Important Notice

  • This extension does NOT provide or control services provided from WellWellWell Investments (Pty) Ltd ("ESP").
  • ESP may have its own terms, policies, and restrictions.
  • Users should carefully review ESP’s rules, API terms, and privacy policies before registering.

🔗 Important Links from ESP

📝 License

This project is licensed under the MIT license.

See the LICENSE file for full details.


Installation Guide

ZparkWise Installation gif


Project Overview

The ZparkWise SA Loadshedding Chrome Extension is designed to visualize data from the publicly available Eskom Se Push (ESP) API.

Features

  • Access the latest information on load shedding schedules.
  • A simplistic design for easy navigation and data interpretation.
  • Cache configuration to save on API call count (if you are using a free account)

ZparkWise Promo Image

ZparkWise Promo Image


Development Setup


Prerequisites

This project was generated with Angular CLI version 17.1.2.

Ensure you have the following installed:

  • Node.js
  • Angular CLI

Installation

  1. Clone the repository

  2. Open command prompt and navigate to the cloned repository

cd ZparkWise
  1. Once inside the target repository folder install all the required dependencies using the following NPM command.
npm install

Serving / Running the Application

Once you have completed the installation guide above we are ready to run the development server with:

ng serve

Navigate to the following url:

http://localhost:4200/

The application will automatically reload if you change any of the source files.


Building the Application to test in Chrome

  1. Open Command Prompt in the cloned repository folder and run the following command
ng build

Use the following flag for a production build.

--configuration production

(When using this flag the environment variables will be set to production to simulate what the application will run like for end users)

The build artifacts will be stored in the dist/ directory.

  1. Next Open Google Chrome and go to the Extensions management page by entering the following in the address bar.
chrome://extensions/

If you have not done so already you will need to enable Developer Mode.

In the top right corner of the Extensions page, toggle the switch to enable Developer mode.

Then we should be ready to load the unpacked extension.

  1. Click the Load unpacked button that appears after enabling Developer mode. A file dialog will open. Navigate to the directory where your extension files are located and select the folder.

Once all the steps above are complete you should be able to find the unpacked extension in your installed chrome extensions shortcut in the top right corner of Chrome.


Contributing

We welcome contributions to improve the ZparkWise SA Loadshedding Chrome Extension!

If you have suggestions for new features or improvements, feel free to create a pull request or open an issue.


About

A chrome extension that utilizes the Eskom Se Push Loadshedding APIs. Stay informed about load shedding schedules in South Africa.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published