Coder Social home page Coder Social logo

bricks-kznncwaq's Introduction

backlight.dev Github Repo

BRICKS Logo

BRICKS Starter Kit

BRICKS is a Design System Starter Kit based on MUI:

a simple and customizable component library to build faster, beautiful, and more accessible React applications

It configures MUI with sensible defaults, makes it ready for your extensions where needed, and lays a foundation for your future documentation.

Features

  • โ™ป๏ธ Open source
  • ๐Ÿ”ฅ ~50 components in 7 categories
  • ๐ŸŽจ Tokens-based theming system
  • ๐Ÿงฑ MUI's compatible theme generated with createTheme
  • ๐Ÿ“– MUI's components documentation embedded
  • ๐Ÿ“š Interactive documentation
  • ๐ŸŒ— Dark mode support

Design Tokens

BRICKS takes the Design Tokens as in MUI Theme Configuration Variables as well as advanced ones:

and make them automatically documented and visually discoverable.

Components

BRICKS comes with +40 components to get started, in 7 categories: Inputs, Data-display, Feedback, Surfaces, Navigation, Layout, and Date/Time. Everything to cover the basics, and more.

Usage

Getting Started in Backlight (recommended)

This is the recommended way, as Backlight gives you an all-in-one Design system platform.

In order to create your own project from this Starter Kit using Backlight, and sign up or log in if you already have an account. Make sure you have a workspace, then go to the Backlight starter-kits list and click the BRICKS card. It will create a project based on this starter kit for you.

Duplicate in Backlight

Make sure you have a Backlight Workspace, then go to starter-bricks on backlight and click the Duplicate button in the top bar to fork it.

Documentation

Design System Documentation

BRICKS is shipped with a good documentation basis which starts in this introduction and then walks you through the usage of tokens and components. Just open it and start exploring!

Backlight Documentation

We created DS Mastery to help you become a hero in the design system development.

To learn about Backlight features there is an official documentation too.

Contributing

Feel free to contribute by duplicate the project in Backlight then open your PR on this repository.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.