# optimus-ui

> 🤖 Optimus This is the UI library for Tripplo's Optimus design system.

Latest version **0.0.6** (published 2021-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install optimus-ui
pnpm add optimus-ui
yarn add optimus-ui
bun add optimus-ui
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2021-03-31 |
| First published | 2020-07-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | AmoDinho |
| Maintainers | princeashburton, vesta-nassone |

## Links

- npm: https://www.npmjs.com/package/optimus-ui
- Repository: https://github.com/Tripplo-Software/optimus
- Homepage: https://github.com/Tripplo-Software/optimus#readme
- Issues: https://github.com/Tripplo-Software/optimus/issues
- npm.io page: https://npm.io/package/optimus-ui

## Dependencies (5)

- [antd](https://npm.io/package/antd.md) ^4.15.0
- [tailwindcss](https://npm.io/package/tailwindcss.md) ^1.4.6
- [typeface-roboto](https://npm.io/package/typeface-roboto.md) ^1.1.13
- [rollup-plugin-svg](https://npm.io/package/rollup-plugin-svg.md) ^2.0.0
- [styled-components](https://npm.io/package/styled-components.md) ^5.2.1

## Recent versions

- 0.0.6 (latest) — 2021-03-31
- 0.0.5 — 2021-03-31
- 0.0.4 — 2021-03-31
- 0.0.3 — 2021-03-31
- 0.0.2 — 2021-03-25
- 0.0.1 — 2021-03-25
- 0.1.1 — 2020-07-28
- 0.1.0 — 2020-07-27

## README

<div align="center">
    <div><span>🤖</span></div>
    <h1 align="center">Optimus</h1>
    <p>This is the UI library for Tripplo's Optimus design system. 
    <a href="https://github.com/Tripplo-Software/optimus" title="Tripplo Optimus">
    </a>
    <p>
      <img alt="MIT License" src="https://img.shields.io/github/license/Tripplo-Software/optimus"/>
      <img src="https://img.shields.io/github/issues/Tripplo-Software/optimus">
      <img src="https://img.shields.io/npm/v/optimus-ui">
    </p>
  </div>
  Optimus UI is a React component library built with TailwindCSS for  <a href="htpps://tripplo.co">Tripplo</a>'s frontends.

## Documentation 📝

To read up on how to use the components head over to <a href="https://optimus-ui.netlify.app/">Storybook</a>.

## Getting started ⛑️

```shell
$ yarn add optimus-ui
```

Or use NPM if you prefer:

```
$ npm i optimus-ui
```

## Usage 🍩

```tsx
import './styles.css'
//import the components from the package
import { Button, Typography } from 'optimus-ui'
//make sure to include the stylesheet in the root of your app
import 'optimus-ui/dist/optimus-ui.css'
export default function App() {
  return (
    <div className="App">
      <Typography variant="HeadingThree">Hello CodeSandbox</Typography>
      <h2>Start editing to see some magic happen!</h2>
      <Button variant="BlueDarkButton" size="small">
        Button
      </Button>
    </div>
  )
}
```

## CodeSandbox Templates 💵

- [JavaScript Starter](https://codesandbox.io/s/black-leaf-vxh85?file=/src/App.js)
- [TypeScript Starter](https://codesandbox.io/s/upbeat-babbage-ji60r?file=/src/App.tsx)

## How to contribute

TBA

## License

MIT © [Tripplo Software](https://github.com/Tripplo-Software)

---
_Source: https://npm.io/package/optimus-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._