Giter VIP home page Giter VIP logo

styleguide's Introduction

Welcome to my React-based Design System

This Design System was created as the single source of truth between design and development. The components here-in shall be used in both Development and the Pattern Library. Therefore, shall changes be made in Design, projects will be able to pull changes from npm.

Setup

To launch the referenceable Pattern Library:

  1. Add this to a new page: import App from '@jedhelmers/styleguide/src/App'
  2. Return <App/>... or something like that. I've never done this but in theory...

Use

  1. To use, simply run npm i @jedhelmers/styleguide in terminal.
  2. Then npm install
  3. Usage: import { Heading } from '@jedhelmers/styleguide/src/lib/atoms/Heading'

I'm sure there's a better way to design the folder structure, but seeing how this is a trial-run, I'm not too terribly worried about it.

Consult the Pattery Library

This package contains building blocks. The Pattern Library shows you how to use them. Consult it.

Updating

When updating components, add default values to any new incoming-props. This will ensure legacy is supported. It will help minimize tech-debt.

Framer X

I haven't tested these components in Framer yet, but in theory, they should work. That being said, we should be able to pull real components directly into prototypes. Axure be damned!!!!

styleguide's People

Contributors

winjed avatar jedhelmers 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.