# Installation

Get AdminKit for Next.js from GitHub or the AdminKit PRO download, install it with npm, run the dev server on localhost:3000 and build the static export.

## 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-nextjs/releases):

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

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

## Install and run

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

The dev server runs at [http://localhost:3000](http://localhost:3000) 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:3000
npm run dev

# static export into out/
npm run build

# serve out/ at http://localhost:3000 with clean URLs, like a static host does
npm start

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

# Playwright smoke and axe tests on out/ (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 start` serves the last build; run `npm run build` first. It takes another port as an argument (`npm start -- 4000`) or from `PORT`.

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

## Next steps

- [Project structure](/nextjs/docs/getting-started/project-structure/): where the routes, components and data live
- [Deployment](/nextjs/docs/getting-started/deployment/): upload `out/` to a static host

---

Canonical HTML page: https://adminkit.io/nextjs/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