Skip to content

Project Structure ​

The source repository, annotated. Every directory has one responsibility. Paths marked generated are build outputs: they are gitignored, produced by npm run setup or npm run build, and overwritten on the next build — never edit them.

adminvora/
├── src/
│   ├── scss/                       the stylesheet source — see The SCSS Source
│   │   ├── adminvora.scss          entry point: one @use per partial, in cascade-layer order
│   │   ├── _layers.scss            the @layer order
│   │   ├── abstracts/              mixins only (_motion: the `still` mixin; _variants)
│   │   ├── base/                   _reset, _base — element selectors
│   │   ├── layout/                 shell, sidebar, topbar, footer, page header, nav layouts
│   │   ├── components/             one BEM block per partial
│   │   ├── plugins/                restyling for the vendored libraries
│   │   └── utilities/              single-purpose classes
│   ├── css/                        generated: tokens.css, adminvora.css, adminvora.min.css
│   ├── js/adminvora.js             the runtime — one file, no build step
│   ├── demo/demo.js                the demo pages' own scripted behaviour (not in dist/)
│   ├── img/                        logos, favicon, placeholder product and cover images
│   └── vendor/                     generated: the ten vendored libraries, checksum-pinned
├── html/
│   ├── _src/                       page sources: a JSON header plus a body
│   ├── _partials/                  shared fragments — sidebar, topbar, boot script
│   ├── _icons/                     the icon set, one SVG per icon
│   ├── pages/                      generated: the assembled demo pages
│   └── _qa/                        generated: the component QA page
├── index.html                      generated: the demo index
├── starters/                       the eight framework kits; shared markup in _shared/
├── docs/                           this documentation (VitePress)
├── tests/                          browser test suites; visual baselines in tests/visual/
├── tools/                          build scripts, lint gates and their baselines
└── landing-website/                the marketing site

Built deliverables, all generated and gitignored:

PathCommandWhat it is
dist/npm run build:distThe redistributable bundle: CSS, runtime, vendor files, SCSS source
html-dist/npm run build:html-distThe demo pages as a customer receives them
docs-dist/npm run docs:buildThis site, built
dist-package/npm run packThe downloadable zips, checksums and manifest

Where things are defined ​

You want to change…Edit
A colour, preset, radius or other tokentools/build-tokens.mjs, then npm run tokens
A component's looksrc/scss/components/_<name>.scss, then npm run build:css
A demo pagehtml/_src/<page>.html, then npm run build:html
The sidebar or topbar on every pagehtml/_partials/, then npm run build:html
Runtime behavioursrc/js/adminvora.js
A third-party library versionpackage.json + npm run vendor:update

Directory rules ​

DirectoryMay containMust never contain
scss/abstracts/MixinsAnything that emits CSS
scss/base/Element selectorsClass-based components
scss/layout/Shell region stylesComponent internals
scss/components/One BEM block per fileLayout positioning, page-specific rules
scss/plugins/Vendor class overridesNew components
scss/utilities/Single-purpose classesMulti-property components

npm run lint:css enforces the token, specificity and layer rules, and fails on a class defined in more than one component partial.

Read next: Your First Page.

Documentation for @creativeigniter/adminvora