Coder Social home page Coder Social logo

starter-yogi's Introduction

backlight.dev Github Repo

Yogi Logo

Yogi Starter Kit
for Backlight

Yogi is a Design System Starter Kit based on chakra. It configures Chakra with sensible defaults, makes it ready for your extensions where needed and lays a foundation for your future documentation.

Features

  • โ™ป๏ธ Open source
  • ๐Ÿ”ฅ 50+ accessible components
  • ๐ŸŽจ Tokens-based theming system
  • โš›๏ธ Default Chakra's Design Tokens embedded
  • ๐Ÿ“– Chakra's components documentation embedded
  • ๐Ÿ“š Interactive documentation
  • ๐ŸŒ— Dark mode support (coming soon)

Design Tokens

Yogi takes the design tokens as in Chakra-UI as well as advanced ones:

  • Typography
  • Colors
  • Spacing
  • Sizes
  • Shadows
  • Border & Radius
  • Z-indexes

and make them automatically documented and visually discoverable.

Components

Yogi comes with 40+ components to get started: menu, dialog, buttons, checkbox, cards, 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, go to the Backlight website 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 Yogi card, this will create a project based on this starter kit for you.

Duplicate in Backlight

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

Documentation

Design System Documentation

Yogi is shipped with a good documentation basis which starts in the 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.

starter-yogi's People

Contributors

cornelurian avatar mveres avatar gqio avatar georges-gomes avatar m4dz avatar gluck avatar thais-divriots avatar

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.