🚀
Getting started
Install, run, and ship a first change. Commands, env, and the toolchain in one page.
Start here
Noirium UIDeveloper docs
Vue 3 + TypeScript UI kit that ships as both a library and standalone Web Components.
Skip to content
When to read what
| I'm about to… | Read |
|---|---|
| Install and run for the first time | Getting started |
| Look up why something is shaped the way it is | Decisions |
| Add a new component | Components + Architecture |
| Expose a component as a web component | Web components |
| Style anything | Styling |
| Wire up an HTTP call | API patterns |
| Mock an endpoint in Storybook or tests | Storybook & MSW mocking |
| Write tests | Testing |
| Record a user-visible change | Changesets |
| Check a code-review rule | Conventions |
| Write a commit message | Git conventions |
| Understand the toolchain | Vite+ |
| Touch CI | CI |
Live site
Handbook and component demos are deployed from main via GitHub Pages:
- aminhadei.github.io/noirium — docs
- aminhadei.github.io/noirium/storybook — Storybook
Project at a glance
- Stack: Vue 3 + TypeScript strict, UnoCSS (wind4), Vite+ toolchain.
- Two distributions: Vue library (
dist/lib/) and standalone Web Components (dist/webc/) from one source tree. - Tests: Vitest via
vite-plus/test+@vue/test-utilsv2 + jsdom + MSW. - Package manager: pnpm (wrapped by Vite+; prefer
vpcommands). - Versioning: Changesets. Never edit
package.jsonversion orCHANGELOG.mdby hand.