Giter VIP home page Giter VIP logo

core-design-system's Introduction

Overview

core-design is our take on a framework-agnostic design system built with stencil, a web component compiler. We had unique requirements at iFixit and Dozuki which required us to consume components in React, HTML, and PHP today, and who-knows-what tomorrow. core-design was architecturally influenced by Ionic, but adapted for desktop environments using our own internal style guidelines.

Components

  1. Web Components
  2. React Components

Packages

  1. @core-design/components-web
  2. @core-design/components-react

Getting Started

Dependencies

We opted to use lerna to help manage multiple child packages efficiently. To get yourself set up for local development, you'll need node installed to run:

# 1. Install dependencies in the root package.json
npm install

# 2. Install and link dependencies in child packages
npx lerna bootstrap

Local Development

For Stencil development, run:

# from root
npx lerna run start

# from packages/components-web
npm run start

For Storybook development, run:

# from root
npx lerna run storybook

# from packages/components-web
npm run storybook

Publishing to NPM

First time publishing?
  1. You need an NPM account with access to @core-design.
  2. You need to be logged in to npm on your terminal with:
npm login

Compile packages and publish

Before publishing to NPM we need to build child repo packages with lerna:

npx lerna run build

Then, publish to NPM:

npx lerna publish

npx lerna publish will automatically determine which packages should be published and prompt you to choose a new version. In addition to publishing, it will also add and push a commit with the changes necessary to reference the new version. See the lerna publish docs for more info.

core-design-system's People

Contributors

andrewjpiro avatar davidrans avatar dependabot[bot] avatar ianrohde avatar kwiens avatar rjmccluskey avatar

Stargazers

 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.