search

civictheme / uikit

UI atomic component-based library with Storybook integration
https://uikit.civictheme.io/
GNU General Public License v2.0
6 stars 5 forks source link
components library ui uikit ux

readme

CivicTheme logo

CivicTheme - UI Kit

[![GitHub Issues](https://img.shields.io/github/issues/civictheme/uikit.svg)](https://github.com/civictheme/uikit/issues) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/civictheme/uikit.svg)](https://github.com/civictheme/uikit/pulls) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/civictheme/uikit) [![Test](https://github.com/civictheme/uikit/actions/workflows/test.yml/badge.svg)](https://github.com/civictheme/uikit/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/civictheme/uikit/graph/badge.svg?token=NMJD1RDUVQ)](https://codecov.io/gh/civictheme/uikit) ![LICENSE](https://img.shields.io/github/license/civictheme/uikit) [![RenovateBot](https://img.shields.io/badge/RenovateBot-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com)

UI component library with Storybook integration

https://uikit.civictheme.io/

---- > [!Tip] > For support, see [Getting help](https://docs.civictheme.io/getting-help) documentation ## Features - Atomic design - Accessible - Platform-agnostic - Integrated with Drupal: https://www.drupal.org/project/civictheme ## Installing ```bash npm install @civictheme/uikit ``` or download the latest release from [GitHub](https://github.com/civictheme/uikit/releases). ## Contributing Contributions are welcome! If a specific change is being proposed (either a new feature or a bug fix), you can [create an issue](https://github.com/civictheme/uikit/issues/new) documenting the proposed change. ## Maintenance ### Updating minor dependencies ```bash npm install -g npm-check-updates npx npm-check-updates -u --target minor ``` ### Pre-release build All commits to `main` branch are built as a Storybook and automatically deployed to https://civictheme-uikit.netlify.app/ ### Build assets 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 the `componets` 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. ### Check and fix code style npm run lint npm run lint-fix ### Run Storybook npm run storybook ## Releasing Releases to GitHub and NPM are automated via GitHub Actions, but initiated manually. To release a new version, go to the [Release package](https://github.com/civictheme/uikit/actions/workflows/release-manual.yml) 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](https://github.com/civictheme/uikit/releases) and [NPM](https://www.npmjs.com/package/@civictheme/uikit). --- For additional information, please refer to the [Documentation site](https://docs.civictheme.io/ui-kit)