https://github.com/adaptiveconsulting/ui-kit-2022
https://github.com/adaptiveconsulting/ui-kit-2022
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/adaptiveconsulting/ui-kit-2022
- Owner: AdaptiveConsulting
- Archived: true
- Created: 2022-09-21T19:16:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T21:43:13.000Z (over 3 years ago)
- Last Synced: 2025-04-11T18:43:06.181Z (over 1 year ago)
- Language: TypeScript
- Size: 3.66 MB
- Stars: 3
- Watchers: 4
- Forks: 6
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Adaptive UI-Kit 2022
[](https://adaptiveconsulting.github.io/ui-kit-2022/)
[](https://www.npmjs.com/package/@ui-kit-2022/components)
[](https://www.npmjs.com/package/@ui-kit-2022/theme)
## Setup
1. Install [Node.js and NPM](https://nodejs.org/en/download/)
2. Install Yarn2+ (https://yarnpkg.com/getting-started/install) and follow these steps:
- Run: `npm install -g yarn`
- Run: `yarn set version berry`
3. Run the command `yarn`
4. Run the command `yarn prepare`
- This will enable pre-commit check
### Development Workflow
This library is composed of several packages, most of which need to be built before your development and build tooling will work. The quickest way to build the package is to run the command: `yarn build`. To only build the components and theme packages, run `yarn build-lib`.
To quickly start a dev process that watches `@ui-kit-2022/components`, `@ui-kit-2022/theme`, and starts the Storybook preview, run `yarn dev`. You can then make changes in each package and have those changes reflected in Storybook for fast development feedback.
While not always neccessary, you can remove all builds with `yarn clean`.
See the `package.json` in the project root for a set of available quick commands that can be run with `yarn {command}`.
To run a local command on a sub package, for instance if you only want to build a single package, you can run `yarn workspace {package-name} run {command}`. The package name is not the folder name, but the name in the packages own `package.json`. Examples of useful commands:
- `yarn workspace @ui-kit-2022/components run build` to build the component package only.
- `yarn workspace @ui-kit-2022/docs run preview` to run the storybook locally for development.
- `yarn workspace @ui-kit-2022/theme run dev` to run a dev build of the theme package that auto rebuilds on change. The `@ui-kit-2022/components` package also supports a `dev` command. You can also use the shorthand `yarn dev:components` or `yarn dev:theme`.
## Releasing
Releases are handled with [Changesets](https://github.com/changesets/changesets/).
When adding a feature or fixing a bug, add to the changset before commiting and sending a PR if you think that change needs to be specified in the release changelog: `yarn changeset`
As we merge in these changesets, a release PR will be created and updated with all the changesets that have been merged, handling all package version bumps and generating the changelog. Once that PR is approved and merged, a release will be created, and the new package versions will be published to NPM.