Skip to content

ChoTotOSS/ds

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 for UI component development and auto-generated docs
  • โš›๏ธ React declarative component-centric UI. React is also our core UI library of Front End development
  • ๐Ÿ’… Linaria which enable CSS-in-JS styling and extract all CSS to external CSS file.
  • ๐Ÿ“„ System UI Theme Specification as a standard design token format with theme-aware css props helper
  • โฌ‡๏ธ MDX (part of Storybook) for seamless React / JSX documentation

Maintaining the system:

  • ๐ŸŸ Babel and module resolver plugin for transpiling modern JS and static theming
  • ๐Ÿ“ฆ NPM for packaging and distribution
  • ๐Ÿงถ yarn as package manager's CLI
  • ๐Ÿงช Jest as test runner for unit testing
  • ๐Ÿ react-testing-library to assist unit testing React components
  • ๐Ÿšฅ Gitlab CI: Continuous integration
  • โœ… Chromatic to prevent UI bugs in components (by Storybook maintainers)

ยฉ 2020-2022 Chotot.vn. Apache-2.0 license.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages