A boilerplate project that sets up Electron and Prisma with SQLite3.

Additional features:

• Auto updates support via Electron autoUpdater.
• Display a splash window while updating and connecting to the database.
• Setting a custom application icon.
• Web Worker implementation with Electron using IPC handlers to simulate multi-threading.
• Triggering queries from the renderer using IPC handlers with typescript support.
• Creating a custom Prisma seeder.

APIs and Technologies

• Node v18.15.x.
• Electron v25.x.
• Electron Forge v6.x.
• Prisma ORM 5.1.x.
• Chakra UI v2.x.
• SQLite v5.x.
  • On Windows, Python 3.10 or above is required.
• Image Magick v7.x.
  • Used to convert PNGs to ICOs for the app icon.

Getting Started

NOTE: On windows, npm start must be run from CMD.exe, Powershell, or WSL2. More Info.

npm install
npm start

Resetting the Database

A unique Prisma Client is generated from the schema defined in source control which sometimes may need to be regenerated along with the database for troubleshooting purposes.

npm run db:reset

Building Distributables

Generate platform specific distributables.

More Info.

npm run make

Updating Application Icon

The installers only accept an .ico file so it must be manually converted from the base assets/icon.png image.

More Info.

npm run gen:icon