Desktop

The vcassist desktop app.

Quick start

git submodule update --init --recursive
pnpm install

pnpm build
pnpm dev

Project structure

Note

You should read this article from electron documentation in order to understand some of the source code in this repository (make sure you know what a "main process" and a "renderer process" is).

• frontend/ - a submodule for the vc-assist/frontend repository.
• src/ - contains the source files for the electron runtime
  • ipc-main.js - the main process side of the wrapper for RPC calls around ipc
  • ipc-renderer.js - the renderer process side of the wrapper for RPC calls around ipc
  • main.js - the main process entrypoint
  • preload.js - the renderer process entrypoint
  • localstorage.js - manual handling of local storage save behavior (workaround for #22048)
• electron-builder.yml - configures electron-builder

Commands

• pnpm build - builds the frontend, resulting artifacts are in frontend/dist.
• pnpm dev - runs the electron app on a website hosted on http://localhost:5173 (useful if you have a vite devserver running elsewhere).
• pnpm dist - packages & builds app installer.