Installation

RequirementsCopy Anchor Link

Node.js 24 and npm. The version is in .nvmrc, so nvm use selects it.

Get the codeCopy Anchor Link

The free version is on GitHub. Clone it, or download the zip of a release from GitHub Releases:

git clone https://github.com/adminkit/adminkit-react.git
cd adminkit-react

AdminKit PRO is a download after purchase. Unzip it and open the folder in a terminal.

Install and runCopy Anchor Link

npm install
npm run dev

The Vite dev server runs at http://localhost:5173 and updates the page when you save a file. The Analytics dashboard is the home page (/); every other page has the name of its HTML file in AdminKit for Bootstrap, without .html (/pages-settings, /ui-buttons).

ScriptsCopy Anchor Link

# dev server at http://localhost:5173
npm run dev

# production build into dist/
npm run build

# serve dist/ at http://localhost:4173
npm run preview

# ESLint, Prettier, TypeScript and the stats check
npm run lint

# Playwright smoke and axe tests on dist/ (install Chromium once with npm run test:install)
npm test

# format the code with Prettier
npm run format

# recount the pages, plugins and icons into src/data/stats.json and the README
npm run stats

npm run preview and npm test use the last build; run npm run build first.

npm run lint also checks that src/data/pages.json lists every route and that src/data/stats.json is up to date, so run npm run stats after you add or remove a page (see Project structure).

Next stepsCopy Anchor Link

• Project structure: where the routes, components and data live
• Deployment: upload dist/ with a fallback to index.html