Repository navigation
Development Commands
github-actions[bot] edited this page Nov 4, 2025
·
9 revisions
Common commands for development, testing, indexing, and maintenance.
-
npm ci— install exact dependencies -
npm run dev— start Vite dev server (http://localhost:5173) -
npm run build— build static site intodocs/ -
npm run preview— preview the production build locally
-
npm test— run vitest -
npm run test:watch— watch mode -
npm run test:mvp— run PDF MVP engine safeguards (layout, chords, sections)
-
npm run normalize— normalize song/PPTX filenames (underscores) and copyTO_RENAME/*.pptxtopublic/pptx/ -
npm run build-index— generatesrc/data/index.jsonfrompublic/songs/
-
npm run build-resources-index— generatesrc/data/resources.jsonfrompublic/resources/
-
npm run ingest -- <file...>— import DOCX/PDF/TXT to ChordPro skeleton (see Importing-Lyrics) -
npm run convert:short— convert existing songs to short directive style -
npm run repair:meta— repair or fill common metadata fields across songs
-
.env— setVITE_ADMIN_PW=your-password - Optional:
VITE_COMMIT_SHA=$(git rev-parse HEAD)when building to bust caches
-
npm run stats— print counts of files, total lines, and characters (excludesdocs/,node_modules/, and.git/)
-
User Guide
-
Editing & Admin
-
Developer Guide
-
Infrastructure
-
Mobile