AdminKitDocs
Getting started

Download

Get AdminKit from npm (@adminkit/core), a CDN or a GitHub release zip of the built files, or buy AdminKit PRO with 53 pages and 11 plugins.

AdminKit comes as source code you build with Vite, and as compiled CSS, JavaScript and HTML pages you can use as they are.

Free version

The MIT-licensed free version has 20 pages, among them a dashboard, light and dark color modes, and uses Bootstrap 5.3, Chart.js, jsVectorMap, Vanilla Calendar Pro, SimpleBar and 2,015 Lucide icons.

npm

The free version is published to npm as @adminkit/core. The package contains the built dist/ folder:

npm install @adminkit/core

In a bundler, import the stylesheet and the script once:

import "@adminkit/core/css";
import "@adminkit/core";

@adminkit/core is dist/js/app.js, @adminkit/core/css is dist/css/app.css and @adminkit/core/head is dist/js/head.js; every other file stays available under @adminkit/core/dist/. The package ships TypeScript declarations, and the script does nothing when it is imported during server-side rendering. Without a bundler, serve the files from node_modules/@adminkit/core/dist/. The framework guides show the setup for plain HTML and 11 frameworks, among them Laravel, Django, React and Vue.

CDN

unpkg serves every file of the npm package:

<link rel="stylesheet" href="https://unpkg.com/@adminkit/core/dist/css/app.css">
<script src="https://unpkg.com/@adminkit/core/dist/js/app.js"></script>

These URLs always serve the latest published version. Pin a version in production, for example https://unpkg.com/@adminkit/core@<version>/dist/css/app.css, so a new release cannot change your pages unannounced. A plain <script src> works; so does type="module". To apply the visitor's color mode before the first paint, also load head.js in <head> (optional, see Dark mode).

AdminKit PRO

AdminKit PRO is the paid edition: 53 pages, 5 of them dashboards, 3 AI pages (an AI chat, a prompt library and an AI analytics dashboard), light, dark and auto color modes, 3 sidebar color schemes (default, colored and light), a settings panel to switch them, a compact sidebar, and premium support. On top of the free version's plugins it adds ApexCharts, DataTables, FullCalendar, Quill, Choices.js, Inputmask and SortableJS (11 plugins in all), Bootstrap toast notifications, and the Font Awesome 7 icon set; its icon pages list 2,015 Lucide and 2,163 Font Awesome icons.

AdminKit PRO is not published to npm or a CDN. After buying it, build it from its source with the commands in Quick start, and copy dist/ into your project. Its js/app.js is one file, so the framework guides work the same way with a relative import.

View AdminKit PRO

Last updated on

On this page