https://github.com/chototoss/ds
https://github.com/chototoss/ds
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chototoss/ds
- Owner: ChoTotOSS
- Created: 2022-05-19T06:55:50.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-19T11:04:19.000Z (about 4 years ago)
- Last Synced: 2025-05-17T18:36:33.622Z (about 1 year ago)
- Language: HTML
- Size: 1.38 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Intro
> This is a trim off version to share with 3rd-party vendors.
Clad UI Design System is a system of design tokens, guidelines, theming solution and components library that helps Chotot front end and mobile engineers build consistent UIs faster and more satisfyingly.
## Why the name Clad UI?
Clad is the short form of classified ads, which is the main product of our group, besides, clad also mean “to be dressed or to be coated”
## What Clad UI Design System is
- A unified solution for styling components for Chotot Web user-facing platforms
- A theme specifications that define primitive Clad UI design tokens
- A collection of reusable components from atomic inputs to composite components
- A workbench (a.k.a kitchen sink) to preview all available components and their usage guide
- A set of CLI tools to assist generate new components...
## What Clad UI Design System is NOT
- A base framework for doing Chotot web apps (refer to Next.js framework)
- An end user-facing web app
- Any full web page
## Colophon (A.K.A prerequisites to this design system)
### Building components:
- 📚 [Storybook](https://storybook.js.org) for UI component development and [auto-generated docs](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a)
- ⚛️ [React](https://reactjs.org/) declarative component-centric UI. React is also our core UI library of Front End development
- 💅 [Linaria](https://linaria.now.sh//) which enable CSS-in-JS styling and extract all CSS to external CSS file.
- 📄 [System UI Theme Specification](https://system-ui.com/theme/) as a standard design token format with theme-aware [`css` props helper](https://styled-system.com/css)
- ⬇️ [MDX](https://mdxjs.com) (part of Storybook) for seamless React / JSX documentation
Maintaining the system:
- 🐟 [Babel](https://babeljs.io/) and [module resolver plugin](https://github.com/tleunen/babel-plugin-module-resolver) for transpiling modern JS and static theming
- 📦 [NPM](https://www.npmjs.com/) for packaging and distribution
- 🧶 [yarn](https://yarnpkg.com/) as package manager's CLI
- 🧪 [Jest](https://jestjs.io/) as test runner for unit testing
- 🐐 [react-testing-library](https://github.com/testing-library/react-testing-library) to assist unit testing React components
- 🚥 [Gitlab CI](https://docs.gitlab.com/ee/ci/): Continuous integration
- ✅ [Chromatic](https://www.chromatic.com/) to prevent UI bugs in components (by Storybook maintainers)
---
**© 2020-2022 Chotot.vn. Apache-2.0 license**.