MaksIT.WebUI

Shared React UI library for maksit-certs-ui and maksit-vault WebUI apps.

Package

npm package	Description
`@maks-it.com/webui`	Contracts, utilities (`deepDelta`, hooks, HTTP, SignalR), and React components

Source lives under src/ (@maks-it.com/webui — contracts/, core/, components/). Release automation lives under utils/.

Local development

cd src
npm install
npm run build
npm test
npm run storybook

Storybook (npm run storybook) runs a local component catalog with Tailwind, React Router, autodocs, a11y checks, and Vitest component tests (testing widget + npm run test-storybook). Stories live under src/stories/components/; see src/stories/README.md.

Tests and coverage badges (shields.io URLs in this README): utils\Invoke-TestEngine.bat (plugin config in utils\engines\test\scriptSettings.json; uses NpmJestTest + CoverageBadges with badgeFormat: shields).

Release to npmjs

Set Npm environment variable to your npm automation token (logical secret name in scriptSettings.json).
Bump src/package.json version (and tag vX.Y.Z on main when using the publish guard).
Run utils\Invoke-ReleasePackage.bat (or pwsh utils\engines\release\Invoke-ReleasePackage.ps1).

Configured plugins (see utils\engines\release\scriptSettings.json):

Plugin	Role
`NpmReleaseVersion`	Read semver from `src/package.json`
`NpmBuild`	`npm ci` + `npm run build`
`ReleasePublishGuard`	Branch/tag checks before publish
`GitHub`	GitHub release (optional; set `GitHub` env var)
`NpmPublish`	Publish `@maks-it.com/webui`

Refresh shared utils from maksit-repoutils via local-copy sync (no Update-RepoUtils in product repos).

Consume in product repos

npm install @maks-it.com/webui

See assets/docs/NPM_CONSUMPTION.md.

License

MIT

2.2 KiB Raw Permalink Blame History