NirvanaPhX / sagu-ui

It's a simple React UI

It's a simple and faster React UI

Installation

sagu-ui is available as an npm package.

To install it, run:

  //with npm
  npm install sagu-ui

  //with yarn
  yarn add sagu-ui

styled-componets are required

Usage

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

import React from 'react'
import { theme, SaguGlobalStyles, SaguProvider, Button } from 'sagu-ui'

function App() {
  return (
    <SaguProvider theme={theme}>
      <SaguGlobalStyles />
      <Button>Click me</Button>
    </SaguProvider>
  )
}

export default App

Take a look at some examples using Sagu-UI

Contributing

You can contribute to this project by opening an issue or creating a pull request.

What is inside?

• TypeScript
• Styled Components
• Storybook
• Eslint
• Prettier
• Jest

Available commands

• build: build the files in the lib directory
• sb: run the storybook at the address localhost:6006
• prettier:check: check formatting on all src directory
• prettier:format: formats all src directory
• generate <Component name>: create a component boilerplate
• test: test all components

Project structure

/.storybook
/lib
/src
├── index.ts
├── animations
|   ├── placeholder.ts
├── hooks
|   ├── ...
├── packages
|   ├── index.ts
|   ├── Button
|   |   ├── index.tsx
|   |   ├── stories.tsx
|   |   └── styles.ts
|   |   └── test.tsx
├── styles
|   ├── global.ts
|   ├── theme.ts
|   ├── provider.ts

License

This project is licensed under the MIT License.