Skip to content

getting-started.md

Latest commit

 

History

History
38 lines (24 loc) · 848 Bytes

getting-started.md

File metadata and controls

38 lines (24 loc) · 848 Bytes

Getting Started

Requirements

Note

Developing on Windows WSL? This project launches an Electron GUI application and therefore may not work on WSL.

Install

npm install

Build

npm run build

Note

Running into build errors? Try running npm run electron:rebuild and then npm run build

Developing

This will run the application with hot reloading enabled for client-side code and auto relaunches the applications when changes are made to the backend.

npm run dev

Debugging

If using VS Code for development, one can debug the application by setting break points and running the Main + renderer debug mode.

debugging