# Installation

Get AdminKit for React from GitHub or the AdminKit PRO download, install it with npm, run the Vite dev server on localhost:5173 and build dist/.

## Requirements

[Node.js](https://nodejs.org/) 24 and npm. The version is in `.nvmrc`, so `nvm use` selects it.

## Get the code

The free version is on GitHub. Clone it, or download the zip of a release from [GitHub Releases](https://github.com/adminkit/adminkit-react/releases):

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

AdminKit PRO is a download after [purchase](/pricing/#react). Unzip it and open the folder in a terminal.

## Install and run

```bash
npm install
npm run dev
```

The Vite dev server runs at [http://localhost:5173](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`).

## Scripts

```bash
# 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](/react/docs/getting-started/project-structure/#add-a-page)).

## Next steps

- [Project structure](/react/docs/getting-started/project-structure/): where the routes, components and data live
- [Deployment](/react/docs/getting-started/deployment/): upload `dist/` with a fallback to `index.html`

---

Canonical HTML page: https://adminkit.io/react/docs/getting-started/installation/

Site overview for agents: https://adminkit.io/llms.txt (expanded: https://adminkit.io/llms-full.txt) · Documentation: https://adminkit.io/bootstrap/docs/ · Questions: support@adminkit.io