Design System 🎨

Design System is a UI library that leverages the power of various tools such as Husky, ESlint, Prettier, and Chromatic for Storybook to deliver high-quality and consistent UI features across various projects.

📚 Check out the storybook hosted on Chromatic 🎨

Table of Contents 📖

1. Features
2. Local Development
3. Contributing
4. License
5. Disclaimer

Features 🚀

• Markdown Editor and Viewers 🗒️ with support for:
  • GitHub Flavoured Markdown
  • Table of Contents
  • Mermaid diagrams
  • Katex

Local Development 🛠️

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

Installation

# Install dependencies with pnpm
pnpm install

# Start development server with storybook
pnpm run storybook

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

Trunk-Based Development and Git Hooks

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

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

Automated Git Hooks

To maintain code quality, we've set up automated Git hooks that perform the following tasks before any git push operation:

• 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.

Contributing 🤝

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

License ⚖️

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

Disclaimer 🚨

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! 🙌