Documentation

Installation

Install Plumile JS packages as a consumer or prepare the monorepo for contribution.

Consumer installation

Install only the package you need in your application.

npm install @plumile/router
npm install @plumile/filter-query
npm install --save-dev @plumile/eslint-config-typescript

React-facing packages expect React to be provided by the consuming application. Use the package README and package.json peer dependency metadata when checking the exact integration boundary.

Repository installation

Clone the monorepo when you want to contribute to packages, docs, tests, or build tooling.

git clone https://gitlab.com/plumile/js.git
cd js
npm install

The repository expects Node 21+ and npm 10+.

Documentation site prerequisites

The Zola site is static. Local site commands require the zola binary in addition to the npm workspace dependencies.