Skip to content

getting_started.md

Latest commit

 

History

History
62 lines (42 loc) · 1.42 KB

getting_started.md

File metadata and controls

62 lines (42 loc) · 1.42 KB

CV Project – Getting Started

This guide walks you through installing dependencies, building the site, and working with multiple CV configurations.

Prerequisites

  • Node.js — the project pins Node 20 via .nvmrc (use nvm use to match)
  • npm (bundled with Node.js)
  • Playwright Chromium browser — required for PDF generation (npx playwright install chromium)

Check your versions:

node --version
npm --version

Installation

  1. Install dependencies. 
    npm install
  2. Optionally run the build right away to verify everything compiles. 
    npm run build

Development Tasks

Build

Generate the static CV output:

npm run build

Watch Mode

For automatic rebuilds during development, run:

npm run watch

This watches the src/ directory and rebuilds the CV when files change.

Configuration

The project configuration is in cv.config.js. You can customize:

  • CV content sections (markdown files)
  • Stylesheet themes
  • Output options (PDF, HTML, debug mode)

Troubleshooting

  • Delete node_modules and run npm install again if dependency issues arise.
  • Use npm run lint to catch JavaScript or formatting problems before committing.
  • If PDF generation fails, ensure Playwright browsers are installed: npx playwright install chromium

With these commands you should be ready to customize and publish updated CVs.