Just a simple lightsaber hosted on npmjs
I develop this library to be more confident with rollup
, storybook
, gulp
and sass
. Initially in the company I worked in, we need to create reusable component based on a palette that can skin any component. At first this project was a proof of concept, over time our internal library has become our design system used by 3 projects.
Recommended environment:
Node 8
The best way to install and use react-lightsaber
is with npm
or yarn
.
$ npm install react-lightsaber
You can also use yarn
.
$ yarn add react-lightsaber
You can manually download react-lightsaber
from releases.
If you want to use the development version of the library, build from source manually. The development version may be unstable.
$ git clone git@github.com:arnaud-zg/react-lightsaber.git
$ cd react-lightsaber
$ npm install
$ npm run build:style
$ npm run build:library
import ReactLightsaber from 'react-lightsaber'
Our main css
file is located here 'react-lightsaber/index.css'.
Run the automated tests for this system
This project use jest
for unit test.
npm run test
If you want to have enable coverage report.
npm run test:coverage
This project use prettier
, tslint
, eslint
for coding style tests.
npm run format
This project use Travis CI
for continuous deployment.
- Typescript - Typescript
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Arnaud Zheng - Initial work - arnaud-zg
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details