README.md

Catalyst Design System

Package	Description	Status	Docs
@haiilo/catalyst	Core web components		README
@haiilo/catalyst-tokens	Style Dictionary design tokens		README
@haiilo/catalyst-angular	Angular bindings for components		README
@haiilo/catalyst-angular-formly	Angular custom types for Formly		README
@haiilo/catalyst-react	React bindings for components		README
@haiilo/catalyst-vue	View bindings for components		README

Setup

Please take a look at the official design documentation at https://design.haiilo.com and follow the Getting Started guide to learn how to setup your project locally.

When installing dependencies with npm or Yarn Classic, all packages are hoisted to the root of the modules directory. As a result, source code has access to dependencies that are not added as dependencies to the project. In the past, this has resulted in a number of indeterministic errors, that are very hard to debug. As a consequence, this monorepo uses pnpm as a package manager. Please follow the installation guide to get started.

When working with pnpm, we recommend to set the following aliases in your .bashrc, .zshrc, or config.fish:

alias pn='pnpm'
alias pnr='pnpm run'
alias pni='pnpm install'
alias pns='pnpm run start'
alias pnb='pnpm run build'
alias pnt='pnpm run test'

Release

Sadly, the release process is not automated (yet). Here are the steps to take for a new release

1. Start in root folder
2. Run pnpm run release:{patch|minor|major}
3. Run pnpm run build
4. Run pnpm run install
5. Run pnpm run publish
6. Run git push --follow-tags origin main

Code Contributors

This project exists thanks to all the people who contribute.

License

The license is available within the repository in the LICENSE file.