Appearance
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 siteBuilt deliverables, all generated and gitignored:
| Path | Command | What it is |
|---|---|---|
dist/ | npm run build:dist | The redistributable bundle: CSS, runtime, vendor files, SCSS source |
html-dist/ | npm run build:html-dist | The demo pages as a customer receives them |
docs-dist/ | npm run docs:build | This site, built |
dist-package/ | npm run pack | The downloadable zips, checksums and manifest |
Where things are defined
| You want to change… | Edit |
|---|---|
| A colour, preset, radius or other token | tools/build-tokens.mjs, then npm run tokens |
| A component's look | src/scss/components/_<name>.scss, then npm run build:css |
| A demo page | html/_src/<page>.html, then npm run build:html |
| The sidebar or topbar on every page | html/_partials/, then npm run build:html |
| Runtime behaviour | src/js/adminvora.js |
| A third-party library version | package.json + npm run vendor:update |
Directory rules
| Directory | May contain | Must never contain |
|---|---|---|
scss/abstracts/ | Mixins | Anything that emits CSS |
scss/base/ | Element selectors | Class-based components |
scss/layout/ | Shell region styles | Component internals |
scss/components/ | One BEM block per file | Layout positioning, page-specific rules |
scss/plugins/ | Vendor class overrides | New components |
scss/utilities/ | Single-purpose classes | Multi-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.