https://github.com/noviel/react-ui-component-template
[DEPRECATED] Use https://github.com/Noviel/react-on-maxs
https://github.com/noviel/react-ui-component-template
Last synced: about 1 year ago
JSON representation
[DEPRECATED] Use https://github.com/Noviel/react-on-maxs
- Host: GitHub
- URL: https://github.com/noviel/react-ui-component-template
- Owner: Noviel
- Created: 2017-09-11T18:19:16.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-28T13:10:15.000Z (over 8 years ago)
- Last Synced: 2024-03-23T04:00:45.456Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 101 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React UI Component Template
**This project is deprecated!** Use [react-on-maxs](https://github.com/Noviel/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](https://github.com/storybooks/storybook)
- Testing with Jest
- Building assets with Webpack
## Install
```sh
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)
1. Create your awesome component in `src/components/MyAwesomeComponent`
1. `yarn storybook` to launch storybook
1. Write some tests
1. `yarn lint`
1. `yarn test`
1. `yarn build` will produce built files `dist/index.js` and `dist/index.css`, which you can include in other projects:
```javascript
import React from 'react';
import { MyAwesomeComponent } from 'my-ui-lib/dist';
import 'my-ui-lib/dist/index.css';
console.log();
```