Braid Design System

screenshot of Braid Design System
react

Themeable design system for the SEEK Group

Overview:

This guide provides instructions for setting up and installing the Braid library in a project. It is optimized for usage with sku but can be configured for custom build setups with additional guidance from project contributors. The guide covers installation, importing necessary components, and customizing the technical implementation of certain components. It also provides information on style guide migration and local development using pnpm. Additionally, it mentions the use of Chromatic for component screenshot testing and the project's MIT license.

Features:

  • Easy installation process
  • Support for sku and custom build setups
  • Import and use of reset styles and required Braid theme
  • Optional customization of Link and TextLink components
  • Style guide migration guide
  • Local development using pnpm
  • Component screenshot testing with Chromatic
  • MIT license
react
React

React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.

webpack
Webpack

Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.