Design System is a UI library that utilizes tools such as Husky, ESLint, Prettier, and Chromatic with Storybook to provide consistent and high-quality UI features for different projects.

📚 Check out the storybook hosted on Chromatic 🎨

• Design System 🎨
  • Table of Contents 📖
  • Features 🚀
  • Local Development 🛠️
  • Trunk-Based Development and Git Hooks
    • Automated Git Hooks
  • Contributing 🤝
  • License ⚖️
  • Disclaimer 🚨

• Markdown Editor
• Markdown Viewer

Here's how you can set up Design System in your local development environment:

Installation

# Install dependencies with bun
bun install

# Start development server with storybook
bun run storybook

Please refer to the package.json for additional details and scripts.

This repository adopts a Trunk-Based Development approach to encourage:

• Short-lived branches or direct trunk modifications
• Frequent merges
• High collaboration among developers

To maintain code quality, we've set up automated Git hooks that perform various tasks at different stages of the Git workflow:

Pre-Commit Hooks:

• Linting: Enforces a consistent code style across the codebase.
• Formatting: Applies standardized code formatting.
• Testing: Executes all unit tests to catch regressions and errors at an early stage.
• Building: Compiles the code and bundles all assets to ensure everything is set up correctly.

This automation helps keep our codebase clean, stable, and error-free.

If you'd like to contribute, please see our contribution guidelines for more information.

This software is distributed under the terms of the MIT License. You can see the full license here.

This software is currently a work in progress and considered in the ALPHA phase. As we continue to update and improve, please expect features to evolve and APIs to change. We appreciate your patience and value your feedback! 🙌