/UI-lib

Primary LanguageTypeScript

ui lib

We spend time using good community practices to make your project scalable. ❤️

Getting Started

Welcome to the light documentation of Template React Components!

System Requirements

  • Node.js 10 or later
  • MacOS, Windows (including WSL), and Linux are supported

Setup

  1. Clone this repo using git clone --depth=1 https://github.com/monzter50/template-react-component-library.git <YOUR_PROJECT_NAME>
  2. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
  3. Run yarn or npm install to install dependencies .
  4. Run yarn storybook or npm run storybook to see the example app at http://localhost:6006.
  5. Change in your package.json your publishConfig for you https://npm.pkg.github.com/<USERNAME>

These scripts refer to the different stages of developing an application:

  • storybook - Runs which starts App.js in view yours components
  • rollup - Runs build which builds the application for publish usage
  • test - Runs start which starts a check your components

Now you're ready to rumble! 🚥

Contributing

Thank you for your interest in contributing; we are delighted you want to help out. We have a contributing guide to help you get started.

License

This project is licensed under the MIT license, Copyright (c) 2019 Jose Antonio Gonzalez Castro.

Authors

  • Jose Antonio Gonzalez Castro 🛠