Getting Started

Getting Started

Requirements: Node.js >= 22.12, npm >= 10.9.

Create a project

npx @simple-reporting/base@latest init my-report
cd my-report
npm install

init copies the project skeleton, installs the base components into livingdocs/ and writes a .gitignore. npm install triggers postinstall → srl prepare, which copies the srl/ folder into the project.

Develop

npm run dev

Starts the Vite dev server. The SRL Vite plugin regenerates the SCSS imports, the Livingdocs design and the Vue component registrations whenever components, SCSS, Vue files, properties or srl.config.json change.

Build

npm run build

See Build for targets and options.