harrisfauntleroy / design-system

Provides reusable UI components for design consistency. Includes access via NPM, Storybook, and Chromatic.

Design System 🎨

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 🎨

---

Table of Contents 📖

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

Features 🚀

• Markdown Editor
• Markdown Viewer

Local Development 🛠️

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.

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

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

design-system's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): lock file maintenance

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update development dependencies (minor) (@storybook/test-runner, eslint-plugin-sonarjs)
• chore(deps): update development dependencies (major) (@storybook/addon-essentials, @storybook/addon-interactions, @storybook/addon-links, @storybook/addon-onboarding, @storybook/blocks, @storybook/react, @storybook/react-vite, @typescript-eslint/eslint-plugin, @typescript-eslint/parser, chromatic, eslint, eslint-plugin-jest, eslint-plugin-security, eslint-plugin-simple-import-sort, eslint-plugin-sonarjs, eslint-plugin-unicorn, husky, storybook, storybook-dark-mode)
• fix(deps): update dependency vitest to v1
• fix(deps): update remark (major) (react-markdown, rehype-katex, remark-gfm, remark-math, remark-toc)
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update actions/checkout action to v4
• chore(deps): update chromaui/action action to v11
• chore(deps): update dependency ubuntu to v22
• chore(deps): update js-devtools/npm-publish action to v3
• fix(deps): update dependency @uiw/react-md-editor to v4
• fix(deps): update dependency rehype-format to v5
• fix(deps): update dependency rehype-raw to v7
• fix(deps): update dependency rehype-stringify to v10
• fix(deps): update dependency tsup to v8
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

bun

package.json

• @emotion/react ^11.11.1
• @uiw/react-md-editor ^3.23.5
• classnames ^2.3.2
• react ^18.2.0
• react-dom ^18.2.0
• react-markdown ^8.0.7
• react-syntax-highlighter ^15.5.0
• rehype-format ^4.0.1
• rehype-katex ^6.0.3
• rehype-raw ^6.1.1
• rehype-stringify ^9.0.3
• remark-gfm ^3.0.1
• remark-math ^5.1.1
• remark-mermaid-plugin ^1.0.2
• remark-toc ^8.0.1
• tsup ^7.2.0
• vite-plugin-dts ^3.5.2
• vitest ^0.34.1
• @storybook/addon-essentials ^7.4.6
• @storybook/addon-interactions ^7.4.6
• @storybook/addon-links ^7.4.6
• @storybook/addon-onboarding ^1.0.8
• @storybook/blocks ^7.4.6
• @storybook/react ^7.4.6
• @storybook/react-vite ^7.4.6
• @storybook/test-runner ^0.13.0 || ^0.16.0
• @storybook/testing-library ^0.2.2
• @types/react ^18.2.15
• @types/react-dom ^18.2.7
• @types/react-syntax-highlighter ^15.5.7
• @typescript-eslint/eslint-plugin ^6.7.4
• @typescript-eslint/parser ^6.7.4
• @vitejs/plugin-react ^4.1.0
• chromatic ^6.24.1 || ^10.0.0
• eslint ^8.49.0
• eslint-import-resolver-typescript ^3.6.1
• eslint-plugin-file-progress ^1.3.0
• eslint-plugin-import ^2.28.1
• eslint-plugin-jest ^27.4.2
• eslint-plugin-jsx-a11y ^6.7.1
• eslint-plugin-promise ^6.1.1
• eslint-plugin-react ^7.33.2
• eslint-plugin-react-hooks ^4.6.0
• eslint-plugin-react-refresh ^0.4.3
• eslint-plugin-security ^1.7.1 || ^2.0.0
• eslint-plugin-simple-import-sort ^10.0.0
• eslint-plugin-sonarjs 0.24.0
• eslint-plugin-storybook ^0.6.15 || ^0.8.0
• eslint-plugin-unicorn ^47.0.0 || ^50.0.0
• husky 8.0.3
• jest 29.7.0
• jest-environment-jsdom 29.7.0
• lint-staged 15.2.2
• storybook ^7.4.6
• storybook-dark-mode ^3.0.1
• ts-jest ^29.1.1
• typescript ^5.0.2
• vite ^4.4.11 || ^5.0.0
• jackspeak 2.3.6

github-actions

.github/workflows/chromatic.yml

• actions/checkout v3
• oven-sh/setup-bun v1
• chromaui/action v1

.github/workflows/ci.yml

• actions/checkout v3
• oven-sh/setup-bun v1
• JS-DevTools/npm-publish v2
• JS-DevTools/npm-publish v2
• ubuntu 20.04

---

• Check this box to trigger a request for Renovate to run again on this repository

TODO

1. Navigation:

   • Navbar
   • Side Menu
   • Footer
   • Breadcrumb
   • Pagination
   • Tabs

2. User Interface:

   • Buttons
   • Text Inputs
   • Dropdowns
   • Checkboxes
   • Radio Buttons
   • Switches

3. Layout:

   • Grid
   • Card
   • List Item
   • Section
   • Container
   • Modal

4. Data Display:

   • Table
   • List
   • Tooltip
   • Popover
   • Progress Bar
   • Loader
   • Avatar
   • Badge
   • Thumbnail
   • Collapse

5. Feedback:

   • Alerts
   • Notification
   • Pop-up messages
   • Tooltips

6. Media and Icons:

   • Image
   • Icon
   • Video
   • Audio

7. Form Components:

   • Form Group
   • Label
   • Input Field
   • Textarea
   • Select
   • Checkbox Group
   • Radio Button Group

8. Blog Specific:

   • Blog Post Card
   • Comment Section
   • Archive
   • Categories
   • Tags

9. Forum Specific