Skip to content

Getting started

Prerequisites

  • Node.js 22+ and npm 10+
  • Git with Git LFS installed (binary assets are tracked via LFS — see Project rules).
bash
git lfs install   # one time, per machine
git clone https://github.com/Fl0p/korovany.git
cd korovany
npm install

Everyday commands

CommandWhat it does
npm run devStart the Vite dev server (http://localhost:5173)
npm run buildType-check + production build into ./dist
npm run previewServe the production build locally
npm testRun the test suite once (Vitest)
npm run test:watchRun tests in watch mode
npm run lintType-check without emitting
npm run docs:devPreview this documentation site locally

Project layout

See Architecture for the folder structure and where new code belongs.