MAKS-IT/maksit-webui
2
0
Fork 0
mirror of https://github.com/MAKS-IT-COM/maksit-webui.git synced 2026-08-15 09:58:09 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity
12 Commits 1 Branch 13 Tags 1.5 MiB
TypeScript 66.8%
PowerShell 31.3%
JavaScript 1.7%
Shell 0.1%
v0.4.3
Go to file
Maksym Sadovnychyy ecce33e42f
Some checks failed
Storybook tests / storybook-tests (push) Has been cancelled
Details
(feature): Breadcrumb and RepoUtils update
2026-08-06 04:50:32 +02:00
.cursor (feature): release as unified npm package @maks-it.com/webui, deepDelta fixes 2026-07-07 18:44:01 +02:00
.github/workflows (feature): Release v0.3.0 with Storybook catalog, VaultStyle removal, and colspan Tailwind fixes. 2026-05-26 20:50:57 +02:00
.vscode (feature): release as unified npm package @maks-it.com/webui, deepDelta fixes 2026-07-07 18:44:01 +02:00
assets/docs (feature): add FileBrowser/Modal/Loader/Masonry/LightBox/CookieConsent/Ratings/social buttons and core hooks 2026-07-24 15:55:49 +02:00
src (feature): Breadcrumb and RepoUtils update 2026-08-06 04:50:32 +02:00
utils (feature): Breadcrumb and RepoUtils update 2026-08-06 04:50:32 +02:00
.editorconfig (feature): clearToasts and community RepoUtils sync 2026-07-28 21:01:28 +02:00
.gitignore (feature): clearToasts and community RepoUtils sync 2026-07-28 21:01:28 +02:00
AGENTS.md (feature): release as unified npm package @maks-it.com/webui, deepDelta fixes 2026-07-07 18:44:01 +02:00
CHANGELOG.md (feature): Breadcrumb and RepoUtils update 2026-08-06 04:50:32 +02:00
README.md (feature): Breadcrumb and RepoUtils update 2026-08-06 04:50:32 +02:00

README.md

MaksIT.WebUI

Line Coverage Branch Coverage Method Coverage

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

  1. Set Npm environment variable to your npm automation token (logical secret name in scriptSettings.json).
  2. Bump src/package.json version (and tag vX.Y.Z on main when using the publish guard).
  3. 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