Getting Started

Initial Setup

Installation

To get started with your new project, copy all the project files into a new folder and run

npm install

This will install the project dependencies.

Development

To run the development setup, execute

npm run dev:all

The application will now open up in development mode.

By default you can access the web version of app in a browser by navigating to http://localhost:5173. The activation and validation server for licenses will be available on http://localhost:3000.

The web application / renderer process will have hot reload automatically, and the main process will restart whenever you make changes to the code in /electron.

Build the project

To build the project, execute

npm run build:all

This will generate two new directories, dist (the web version) and release (the electron version).

These files can be used to distribute the software.

Create a release

To create a new release, execute

npm run build:release

This is basically the same as building the project, but with additional steps for production ready releases.