Skip to content

SAKANA7/sagu-ui

Repository files navigation

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

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

What is inside?

Available commands

  • build: build the files in the lib directory
  • storybook: run the storybook at the address localhost:6006
  • prettier:check: check formatting on all src directory
  • prettier:format: formats all src directory

Project structure

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

License

This project is licensed under the MIT License.

About

It's a simple React UI

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.4%
  • JavaScript 1.2%
  • Handlebars 0.4%