OctoAI Demo Design System 🐙

The core design system for OctoAI Demos. This is used as a local package for all demos in the examples directory.

Getting Started

Clone the repo

git clone https://github.com/octoml/demo-design-system.git

Navigate to the design system folder

cd demo-design-system

Install dependencies

yarn

Start the dev server

yarn dev

Start the Storybook dev server

yarn storybook

Building styles

To build out styles, run yarn build:styles. This will update the package output.

Contributing 👨🏽‍💻

Commit Format Follow the Conventional Commits format for commit messages:

<type>(<scope>): <message>

where is the change type (e.g., feat, fix), (optional) specifies the change's scope, and briefly describes the change.

All commit messages are linted using Husky pre-commit.

Semantic Release Automated versioning and releasing

• Create a Pull Request (PR) with Conventional Commit messages.
• PR approval triggers an automatic version release.
• The CI will build all styles before releasing.
• Release notes are generated from commit messages.