saru-ui v1.0.8-alpha.1

SARU-UI

It's a simple and faster React UI

Installation

saru-ui is available as an npm package.

To install it, run:

  //with npm
  npm install saru-ui

  //with yarn
  yarn add saru-ui

Usage

Here is a quick example to get you started, it's all you need:

import React from 'react';
import { Button, GlobalStyles } from 'saru-ui/lib';

function App() {
  return (
    <>
      <GlobalStyles />
      <Button>
        OK
      </Button>
    </>
  );
}

export default App;

What is inside?

• ReactJS
• TypeScript
• Styled JSX
• Storybook
• Eslint
• Prettier

Available commands

• build: build the files in the lib directory
• storybook: run the storybook at the address localhost:6006
• deploy-storybook: deploy the storybook to the branch gh-pages
• prettier:check: check formatting on all src directory
• prettier:format: formats all src directory

Project structure

/.storybook
/lib
/src
├── index.ts
├── packages
|   ├── index.ts
|   ├── button
|   |   └── ...
├── global
|   ├── index.ts
|   ├── styles.ts
/stories
├── packages
|   ├── button
|   |   └── stories.tsx
├── utils

License

This project is licensed under the MIT License.