Skip to content

leonardofaria/leozera-ui

Repository files navigation

leozera-ui

Greenkeeper badge Build Status Build Status codecov Maintainability Test Coverage NPM Package Dependencies Dev Dependencies Code Style Prettier Storybook license

This is my experimental WIP React UI library. The goal here is playing with NPM, React, Webpack (and its multiple loaders), Storybook, Jest, Husky and others in order to create a modular library.

Installing

Yarn:

yarn add leozera-ui

npm:

npm i --save leozera-ui

Using

// Import for the compiled file
import { Button } from 'leozera-ui'

// Somewhere in your code:
return (<Button>Test</Button>)

Developing

# Part 1: getting the project
git clone [email protected]:leonardofaria/leozera-ui.git
cd leozera-ui
yarn install # get dependencies
yarn build:lib # build the library when ready

# Part 2: installing the built version in your project
cd /path/to/your/project
yarn add file:/path/to/leozera-ui/dist

Todo

I have created a Github project to list what is next.