Introduction

Esse repositório contém o design system para o projeto "Motor de Decisão". Ele fornece um conjunto de componentes de UI reutilizáveis e estilos para garantir consistência em toda a aplicação. O design system é construído utilizando tecnologias web modernas, incluindo React, TypeScript, Tailwind CSS e mais.

Structure

Abaixo está a estrutura de diretórios utilizada para o template:

- src
-- @types/: Responsável por conter tipos customizados da aplicação.
-- assets/: Responsável por conter arquivos estáticos da aplicação.
-- components/
--- button/: Responsável por conter componentes relacionados a botões.
---- ...
---- button.story.tsx
---- button.spec.tsx
---- button.tsx
---- index.ts
--- .../: Outros componentes específicos.
-- contexts/: Responsável por conter contexto de compartilhamento de estados globais.
-- config/
--- helpers/: Responsável por conter funções auxiliares.
--- libs/: Responsável por conter funções/configurações de bibliotecas terceiras.
--- themes/: Responsável por conter temas de estilo da aplicação.
-- hooks/: Responsável por conter hooks customizados.
-- docs/: Responsável por conter arquivos de documentação, incluindo os arquivos do Storybook.
-- index.ts: Entry point da aplicação.

Getting Started

Para iniciar o projeto você deve ter instalado em sua máquina o nodejs (20 ou superior) e npm (10 ou superior). Para instalar as dependências do projeto siga o comando abaixo:

npm install

Para executar o projeto do template basta você executar o comando abaixo:

npm run dev

Obs: Esse projeto utiliza em desenvolvimento as bibliotecas Tailwind com Shadcn/ui

Build and Test

Para executar o build do template basta você executar o comando abaixo:

npm run build

Para executar os testes do template basta você executar o comando abaixo:

Obs: Esse projeto utiliza para build, a biblioteca rollup

npm run test

Obs: Esse projeto utiliza a biblioteca vitest para manipulação de testes.