UI component library with Storybook integration
[!Tip] For support, see Getting help documentation
- Atomic design
- Accessible
- Platform-agnostic
- Integrated with Drupal: https://www.drupal.org/project/civictheme
npm install @civictheme/uikit
or download the latest release from GitHub.
Contributions are welcome!
If a specific change is being proposed (either a new feature or a bug fix), you can create an issue documenting the proposed change.
npm install -g npm-check-updates
npx npm-check-updates -u --target minor
All commits to main
branch are built as a Storybook and automatically deployed to https://civictheme-uikit.netlify.app/
npm run build
This will build:
- CSS and JS assets in the
dist
directory. These files can be included directly into your HTML page, provided that it has components implemented with the same markup as components in thecomponets
directory. - Storybook assets as compiled HTML page in the
storybook-static
directory. These files can be served publically to show all components available in the library.
npm run lint
npm run lint-fix
npm run storybook
Releases to GitHub and NPM are automated via GitHub Actions, but initiated manually.
To release a new version, go to
the Release package
GitHub Action, click on the Run workflow
button, and enter the release
level: patch
or minor
.
After the release is complete, the new version will be available on GitHub and NPM.
For additional information, please refer to the Documentation site