Skip to content

Installation ​

Three paths. Pick one; they are not mutually exclusive but mixing them is unusual. Check the Prerequisites first if you will build from source.

PathBuild stepCustomisationBest for
A. Compiled distNoneRuntime tokens onlyServer-rendered apps, quick starts
B. Source repositorynpm scripts (Sass + Node)TotalTeams building a product on it
C. Framework starter kitProvidedTotalGreenfield Laravel/Django/React/etc.

Path A — Compiled dist ​

Copy dist/ into your public asset directory. Nothing else.

public/
└── adminvora/
    ├── css/
    │   ├── adminvora.css        tokens + components, one file
    │   ├── adminvora.min.css    the same, minified
    │   └── tokens.css           tokens only, for regenerating against a custom palette
    ├── js/
    │   └── adminvora.js         the runtime — theme engine, components, charts
    ├── scss/                    the stylesheet's source — recompile rather than override
    ├── vendor/                  ← lazy-loaded third-party modules, keep beside js/
    ├── img/
    ├── LICENSE.md
    └── NOTICE.md                third-party notices — must travel with the bundle

You do not need scss/ to run the product — link the two files below and skip it. It is there for restyling: overriding the compiled stylesheet means writing unlayered rules that beat every cascade layer unconditionally, so the first override wins permanently and the layer order stops meaning anything. Recompiling keeps your changes inside the cascade. See The SCSS Source for what shipping it promises and, just as importantly, what it does not: there are no !default variables, so @use 'adminvora' with (…) has nothing to configure.

That is the whole bundle. There is no minified runtime, no source map, no chunks/ directory, no subsetted fonts and no icon sprite. dist/README.md, written by build:dist into the bundle itself, is the single writer for this tree, and npm run check:bundle fails the build if a fenced example on any page links a file the bundle does not contain.

Minimum viable page:

html
<!doctype html>
<html lang="en"
      data-bs-theme="light"
      data-av-preset="aurora"
      data-av-layout="vertical"
      data-av-density="comfortable">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Dashboard · AdminVora</title>

  <!-- 1. Boot script — MUST be first, MUST be synchronous, MUST be inline -->
  <script>
    (function () {
      var d = document.documentElement, s;
      try { s = JSON.parse(localStorage.getItem('adminvora.prefs') || '{}'); } catch (e) { s = {}; }
      var mode = s.mode || 'system';
      var dark = mode === 'dark' ||
        (mode === 'system' && matchMedia('(prefers-color-scheme: dark)').matches);
      d.setAttribute('data-bs-theme', dark ? 'dark' : 'light');
      ['preset','style','layout','nav-skin','density','radius','sidebar','topbar','width','contrast','motion','depth']
        .forEach(function (k) { if (s[k]) d.setAttribute('data-av-' + k, s[k]); });
      if (s.dir) d.setAttribute('dir', s.dir);
      d.classList.add('av-booting');
      requestAnimationFrame(function () {
        requestAnimationFrame(function () { d.classList.remove('av-booting'); });
      });
    })();
  </script>

  <!-- 2. Optional: preload the face used above the fold. The bundle ships
       Inter, Plus Jakarta Sans and JetBrains Mono in vendor/fonts/; preload
       one face, not all three. -->
  <link rel="preload" href="/adminvora/vendor/fonts/inter/inter-latin-opsz-normal.woff2"
        as="font" type="font/woff2" crossorigin>

  <!-- 3. Stylesheet -->
  <link rel="stylesheet" href="/adminvora/css/adminvora.min.css">
</head>
<body>

  <div class="av-shell">
    <aside class="av-sidebar" id="avSidebar" data-av-sidebar>…</aside>
    <div class="av-main">
      <header class="av-topbar" data-av-topbar>…</header>
      <main class="av-content" id="main">
        <div class="container-fluid">
          <h1 class="av-page-header__title">Hello, AdminVora</h1>
        </div>
      </main>
      <footer class="av-footer">…</footer>
    </div>
  </div>

  <!-- 4. Runtime — defer, at the end of body -->
  <script src="/adminvora/js/adminvora.js" defer></script>
</body>
</html>

Important — vendor/ must stay a sibling of js/. The lazy vendor loader resolves ../vendor/… against the runtime script's own URL, so a pipeline that moves or hashes adminvora.js without moving vendor/ with it breaks the first chart, grid or editor on the page and nothing else. Set the base explicitly before loading the runtime in that case:

html
<script>window.__AV_ASSET_BASE__ = 'https://cdn.example.com/adminvora/js/';</script>

The value is the directory the runtime is served from — the js/ folder, not the bundle root — because that is what ../vendor/ is resolved against. A missing trailing slash is added for you. It is the only global AdminVora reads, tools/runtime-globals.mjs is the list, npm run check:globals fails the build if any name on it has no reader in src/js/, and npm run test:asset-base proves the override from the path the server was actually asked for.

RTL ​

Set dir. There is no second stylesheet:

html
<html lang="ar" dir="rtl">
<link rel="stylesheet" href="/adminvora/css/adminvora.min.css">

The stylesheet is written in logical properties throughout, so direction is a document attribute rather than a build target. The handful of things with no logical form — transform, translate, clip-path — carry their sign in a custom property that one [dir="rtl"] rule flips, and npm run test:rtl walks every page in RTL asserting nothing escapes either edge.


Path B — Source repository ​

bash
git clone https://github.com/CreativeIgniter/adminvora.git
cd adminvora
npm install
npm run setup      # vendored assets, placeholder images, then the build
npm run dev        # http://localhost:5173

npm run setup is idempotent and required after a fresh clone — src/vendor/ is not committed, only its manifest and checksums are. See Asset Vendoring.

Builds:

bash
npm run build            # tokens, stylesheet, and html/pages/ from html/_src/
npm run build:dist       # → dist/          the redistributable bundle
npm run build:html-dist  # → html-dist/     the pages a customer receives
npm run dev              # serve the working tree at :5173

There is no separate preview server: npm run dev is a static host over the repository, so it serves whichever of those three outputs you point the browser at.

What npm run setup does ​

It is three commands — npm run vendor && npm run images && npm run build:

  1. Reads tools/vendor.manifest.json, copies the pinned files from node_modules into src/vendor/, and verifies each file's SHA-256 against the manifest; a mismatch aborts.
  2. Draws the placeholder product and cover images into src/img/.
  3. Builds: src/css/tokens.css from tools/build-tokens.mjs, the stylesheet from src/scss/, and the demo pages in html/pages/ from html/_src/. None of these outputs are committed.

None of it reaches the network beyond the npm install you already ran.


Using a bundler ​

There is no npm package. Point your own build at the compiled bundle: the runtime is a classic script that assigns window.AdminVora, so it goes in a <script> tag rather than an import, and the stylesheet is a plain CSS file your bundler can import from wherever you copied dist/ to.


Path C — Framework starter kits ​

Preconfigured repositories with routing, layouts, and asset pipelines already wired.

The scaffolder runs from this repository; there is no npm package. It copies the compiled dist/ into the kit, so build the bundle first:

bash
npm install
npm run setup
npm run build && npm run build:dist
npm run create -- my-app --kit=laravel

npm run starters:list prints the eight ids: static-html, laravel, django, express-nunjucks, react-vite, vue-vite, nextjs, nuxt. Anything you leave out is asked for on a terminal:

Project directory › my-app

Choose a stack:
   1. Static HTML — Zero build step. Copy the assets, write HTML, done.
   2. Laravel 11 — Blade layout, partials and named routes over the compiled bundle.
   …
Number › 2
App name [Acme] › Acme
Theme preset [aurora] › aurora

The flags are --kit, --name, --preset, --layout, --yes (never prompt) and --no-assets (scaffold the templates without copying dist/). npm run pack:starters builds all eight and zips them.

Each kit is documented in Framework Integration.


Verifying the install ​

Open any page and check the console:

js
AdminVora.version              // "1.0.1"
AdminVora.theme.get('mode')    // "light"
AdminVora.theme.get('preset')  // "aurora"
AdminVora.toast.show({ title: 'Installed', message: 'The runtime is up.' });

theme.get takes one key and returns one string; there is no object form and no module registry to list. The public surface is eleven members — theme, toast, confirm, loading, a11y, utils, on, emit, init, destroy, version — and utils holds exactly one function, formatCurrency. See JavaScript Architecture.

If AdminVora is undefined, the script did not load — check the network tab and confirm the path. Common causes are listed in Troubleshooting.

Read next: Project Structure.

Documentation for @creativeigniter/adminvora