PowerLeaf - Laptop Energy Well-being

A cross-platform desktop React application build with Electron Forge.

Installation

Prerequisites

Make sure you have following installed on your machine:

• Node.js

Use the package manager npm to install dependencies from the package.json file.

npm install

Git pre-commit hook

Install Husky pre-commit hook, if it hasn't installed automatically.

npm run prepare

Usage

Running in Development Mode

To start the application in the development mode, use:

npm run start

This will open the application with live reloading enabled.

Running in Production Mode

Package

This will creat an executable bundle for a target operating system. By default, running the Package step will only create a packaged application for your machine's platform and architecture.

npm run package

npm run package:mac=arm64

npm run package:mac=x64

npm run package:win

After the Package step, your packaged application will be available in the /out/ directory.

Make

Forge's Make step takes the bundled executable output from the previous Package step and creates "distributables" from it.

npm run make

The output of the make command is typically found in the /out/make directory. It contains the installers and zip files that can be distributed to users.

Publish

Forge's Publish step takes the distributable build artifacts from the Make step and uploads for distribution to your app's end users (e.g. to GitHub Releases or AWS S3 static storage). Publishing is an optional step in the Electron Forge pipeline, since the artifacts from the Make step are already in their final format.

npm run publish

Rebuild

Electron Rebuild executable rebuilds native Node.js modules against the version of Node.js that your Electron project is using.

Running rebuild to fix sqlite3 module error, if occurs.

npm run rebuild

Lint

Eslint

Run eslint to analyze and fix your .js, .jsx code problems.

npm run lint:fix

Stylelint

Run stylelint to analyze and fix your .css, .scss errors.

npm run stylelint:fix

Eslint + Stylelint

Run eslint and stylelint together.

npm run format