Giter VIP home page Giter VIP logo

components-library's Introduction

Demo component library

First time setup

  1. Use only npm for running scripts, in order to avoid some unexpected conflicts with different .lock files;
  2. Run npm i command to install project dependencies;
  3. Run npm run start to start Storybook and review components.

Publishing

Note: before publishing packages, you must have npm account and setup organization in order to publish scoped packages.

  1. Build components by running npm run build:components command;
  2. Publish components by running npm run publish:components command.

Development

  • Create new component under src directory;
  • Every component must have src directory with all of the source code. Include index.js file in order to avoid specific file path import declaration;
  • Each component must include package.json file, and should include .npmignore, CHANGELOG.md, LICENCE, README.md files;
  • When using imports from other components use their package.json name and include that name and specific path to aliases under /configs/aliases.config.js;
  • In order to check if published component works, add dependency to root package.json file, run npm i command and comment specific alias. Run storybook and test it.

components-library's People

Watchers

James Cloos 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.