Skip to content

Prerequisites ​

You need nothing to use the compiled dist/ bundle or the ready-made HTML pages: link the files and open them in a browser. The tools below are for building from source and running the starter kits.

Node.js ​

Node 20 or newer. The repository's .nvmrc pins the version CI uses, so with nvm (or nvm-windows):

bash
nvm install
nvm use
node --version

package.json declares "engines": { "node": ">=20" }, but npm only warns on a mismatch and installs anyway. An older Node then fails later, inside a build script, so check the version first.

npm ​

The examples use npm, and package-lock.json is the lockfile that is maintained.

A browser for the test suites ​

Only needed if you run npm test. The suites launch Microsoft Edge through Playwright by default, and a few always use Playwright's own Chromium. Without Edge, set AV_BROWSER=chromium and every suite uses that Chromium:

bash
npx playwright install chromium

Verifying your environment ​

After npm install and npm run setup:

bash
npm run vendor:audit    # every vendored file against its recorded SHA-256

This is the check that matters after a clone. A half-finished setup looks like a page that renders but whose lazy-loaded vendor 404s in the browser; vendor:audit catches it.

Windows note — enable long-path support if you see ENAMETOOLONG during install: git config --system core.longpaths true.

Read next: Installation.

Documentation for @creativeigniter/adminvora