README.md

Javabattery

  

Supported Platforms     

Features

1. Nice UI (made with TailwindCSS)
2. Notifications on battery percentage (never get caught off-guard again)
3. Customizable battery levels for notifications (v1.0.3)
4. A moving blob (because why not - it is also an highlighter)
5. Battery percentage changes in realtime

Pre-requisites

1. ImageMagick (see https://imagemagick.org/script/download.php) - for image conversions

Setup

The commands I'll be using are for pnpm, but you can use yarn or npm if you want.

• Step 1

# Install dependencies and build icons used in the project
$ pnpm install

• Step 2

# Create the icons used in the project
$ pnpm build:icons

• Step 3

Copy build/icons/icon.ico to public/ and then rename icon.ico -> favicon.ico

Running

Development

After running the command below a window open and the project will be running on http://localhost:3000

# Runs the development server and opens electron
$ pnpm dev

Production

To build and package the application, run the following command:

# Builds the frontend and packages the application
$ pnpm release

TODOs

1. Add the ability for users to add custom battery levels for notifications