Watt's My Bill

A simple Flutter app to calculate your electricity bill based on TNB's domestic tariff rates.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

Watt's My Bill is a Flutter mobile application developed as part of a Mobile Technology Assignment. It aims to help users easily estimate their electricity bills based on their consumption and the current tariff rates provided by Tenaga Nasional Berhad (TNB), Malaysia's primary electricity utility company.

Features

• Calculate electricity bill: Enter your electricity consumption in kilowatt-hours (kWh) and any applicable rebate percentage.
• View TNB tariff rates: Access detailed information about TNB's domestic tariff rates (as of May 2024) to understand how your bill is calculated.
• Customizable: Adjust the app's appearance with different themes.
• Error handling: Provides clear error messages for invalid inputs.

Built With

(back to top)

Getting Started

To run this app on your local machine, follow these steps:

Prerequisites

• Flutter SDK: Make sure you have the Flutter SDK installed. You can download it from the official Flutter website: https://flutter.dev/

Installation

1. Clone the repo:

   git clone https://github.com/Kyziq/watts-my-bill-calculator
   

2. Install dependencies:

   flutter pub get
   

3. Run the code:

   flutter run

(back to top)

Usage

Estimate your electricity bill with ease:

1. Enter Units: Input the total electricity units consumed (in kWh).
2. Optional Rebate: If you have a rebate, enter the percentage in the "Rebate Percentage" field. Leave it blank if you don't have a rebate.
3. Calculate Bill: Click the "Submit" button to get your estimated bill.
4. View Tariff Rates (Optional): For a detailed breakdown of TNB's tariff rates (as of May 2024), click the info (🛈) button.

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)