Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cellectio/zparkwise
A Reactive Chrome Extension built on top the ESP API
https://github.com/cellectio/zparkwise
Last synced: 15 days ago
JSON representation
A Reactive Chrome Extension built on top the ESP API
- Host: GitHub
- URL: https://github.com/cellectio/zparkwise
- Owner: CellectIO
- License: gpl-3.0
- Created: 2024-05-17T14:37:28.000Z (8 months ago)
- Default Branch: develop
- Last Pushed: 2024-07-29T10:51:19.000Z (5 months ago)
- Last Synced: 2024-07-30T14:24:01.959Z (5 months ago)
- Language: TypeScript
- Size: 3.44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZparkWise SA Loadshedding Chrome Extension
A Reactive Chrome Extension built on top of the public facing API's from **wellwellwell investments (Pty) Ltd (“ESP”)**
---
## Disclaimer:
This Chrome extension is not affiliated with or endorsed by **wellwellwell investments (Pty) Ltd (“ESP”)**.
#### USE AT YOUR OWN DISCRETION.
---
## Important links from ESP
- https://esp.info/
- https://esp.info/privacy
## License
This project is licensed under the **GNU GENERAL PUBLIC LICENSE**
see the LICENSE file for more details.
---
## Project Overview
The ZparkWise SA Loadshedding Chrome Extension is designed to visualize the publicly available Eskom Se Push (ESP) API.
This extension provides users with a convenient way to access and interpret data regarding electricity load shedding schedules in South Africa.
Built using Angular, this extension offers a seamless and reactive user experience.
## Features
- Access the latest information on load shedding schedules.
- A simplistic design similar to the mobile application for easy navigation and data interpretation.
- Cache configuration to save on API call count (if you are using a free account)
---
## 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 and install the necessary dependencies:
2. Open command prompt and navigate the the cloned repository
```bash
cd ZparkWise
```
3. Once inside the target repository folder install all the required dependencies using the following NPM command.
```bash
npm install
```
---
### Serving / Running the Application
Once you have completed the installation guide above we are ready to run the development server with:
```bash
ng serve
```
Navigate to the following url:
```bash
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
```bash
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 run in for end users)
**The build artifacts will be stored in the dist/ directory.**
2. Next Open Google Chrome and go to the Extensions management page by entering the following in the address bar.
```bash
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.
3. 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.
### Steps to Contribute
- Fork the repository.
- Create a new branch (git checkout -b feature/YourFeature develop -t).
- Commit your changes (git commit -m 'Add some feature').
- Push to the branch (git push origin feature/YourFeature).
- Open a pull request :)
---