norma-library/README.md

Olos/Norma-DS. Design System based on Material UI, developed with TypeScript and Styled Components to create reusable and consistent components in web applications.

<!-- markdownlint-disable-next-line -->
<p align="center">
  <img width="120" height="120" src="https://www.olos.com.br/wp-content/uploads/2023/03/cropped-selo-olos-1-180x180.png" alt="Olos logo">
</p>
<h1 align="center">Norma DS </h1>
<div align="center">
Olos/Norma-DS. Design System based on Material UI, developed with TypeScript and Styled Components to create reusable and consistent components in web applications.

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE)
[![npm latest package](https://img.shields.io/npm/v/@mui/material/latest.svg)](https://www.npmjs.com/package/@mui/material)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[Documentation](#Documentation) |
[Contributing](#Contributing) |
[Changelog](#Changelog) |
[License](#License)

---

</div>

## Configurações

- [React v18](https://react.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- UI development with [Storybook](https://storybook.js.org/)
- Unit test with [Testing-library](https://testing-library.com/)
- Linting with [Eslint](https://eslint.org/) and code formatting with [Prettier](https://prettier.io/)
- Conventional commit messages with [Commitlint][commitlint-url]
- Build the library with [Rollup][rollup-url]
- Automated release with [changesets][changesets-url]

# Documentação

### Instalação
Para instalação das dependencias:
``` 
npm install
```
### Execução do projeto
Para utilizar o Storybook:
```
npm run storybook
```