React UI based on the
`@mui/material`
toolkit for the web.
[](https://www.npmjs.com/package/flipper-ui)
[](https://www.npmjs.com/package/flipper-ui)
## Installation
Flipper-UI is available as an [npm package](https://www.npmjs.com/package/flipper-ui).
```sh
npm install flipper-ui
```
```sh
yarn add flipper-ui
```
## Usage
Here is a quick example to get you started, **it's all you need**:
```tsx
import React from 'react'
import { render } from 'react-dom'
import { Button } from 'flipper-ui'
const App = () => {
return (
)
}
render(, document.getElementById('root'))
```
## Documentation
Check out our [documentation website](https://flipper-ui.ngi.com.br/?path=/docs/introduction--docs). You can also interact with the components there!
## Contributing
Bug reports, feature requests and other contributions are more than welcome!
Whenever possible, please make a pull request with the implementation instead of just requesting it.
> If the feature is big, open an issue first for discussion.
## License
This project is licensed under the terms of the
[MIT license](/LICENSE).
