/react-ui-component-template

[DEPRECATED] Use https://github.com/Noviel/react-on-maxs

Primary LanguageJavaScript

React UI Component Template

This project is deprecated! Use react-on-maxs

Template for rapid development of React component/library as a standalone package.

Features

  • Modern JavaScript features (ES6+)
  • Styling with SCSS and PostCSS
  • The best developer experience with Storybook
  • Testing with Jest
  • Building assets with Webpack

Install

git clone git@github.com:Noviel/react-ui-component-template.git

Quick start

  1. Modify package.json corresponding to your project (name, author, repository, e.t.c)
  2. Create your awesome component in src/components/MyAwesomeComponent
  3. yarn storybook to launch storybook
  4. Write some tests
  5. yarn lint
  6. yarn test
  7. yarn build will produce built files dist/index.js and dist/index.css, which you can include in other projects:
import React from 'react';
import { MyAwesomeComponent } from 'my-ui-lib/dist';
import 'my-ui-lib/dist/index.css';

console.log(<MyAwesomeComponent />);