Skip to content

setup-and-run.md

Latest commit

 

History

History
58 lines (39 loc) · 1.3 KB

setup-and-run.md

File metadata and controls

58 lines (39 loc) · 1.3 KB

How to Run CV Builder

Prerequisites

  1. Install Node.js 18+ from https://nodejs.org
  2. Install pnpm once:
npm install -g pnpm

Browser Mode

Option A: Windows Helper Script

Double-click start-app.bat.

What it does:

  1. Checks that pnpm is available.
  2. Finds a free local port between 5173 and 5200.
  3. Starts the Vite dev server.
  4. Opens the browser automatically.

Option B: Terminal

pnpm install
pnpm dev

Then open the local URL shown by Vite, usually http://localhost:5173.

Electron Desktop Mode

pnpm install
pnpm electron:dev

This starts both the Vite dev server and the Electron window.

Building for Distribution

pnpm electron:build:portable  # Portable .exe (no installer)
pnpm electron:build           # NSIS installer + portable
pnpm electron:build:installer # NSIS installer only

Build output goes to release/ (installer) or release-portable/ (portable).

Troubleshooting

  • If pnpm is not found, run npm install -g pnpm and open a new terminal.
  • If the default port is busy, Vite or start-app.bat will use another free local port.
  • If dependencies are broken, delete node_modules/ and run pnpm install again.
  • On Windows, check-setup.bat can verify the local setup.