Título do projeto

Navegue pela documentação:

Arquitetura e stack	Instalação e Como usar

📋 Arquitetura e stack

Este projeto faz parte de um conjunto de aplicações estruturadas em uma arquitetura de microserviços, e em uma arquitetura Featured Sliced com a seguinte organização de pastas:

⚡ Tech Stack

Código feito em Typescript
Testes utilizando Vitest

📦 Instalação e Como usar

Instalação

Para executar os scripts é necessário configurar as variáveis de ambiente:

DATABASE_URL: com endereço completo de conexão com banco de dados Postres.
EVENT_BUS_URL: com endereço completo de conexão com o barramento de eventos, o Kafka.

Os scripts de execução estão implementados utilizando o Npm e o Vite, para instalar execute:

npm install # Instala todas as dependências do projeto

Como usar

npm run dev # Executa o projeto localmente

⚙️ Orientações para desenvolvimento

A cada funcionalidade desenvolvida deve ser criada uma nova branch seguindo o seguinte formato: feat/{desc} -> Para novas funcionalidades fix/{desc} -> para ajustes e correções de bugs

A partir da branch deve ser aberto um Merge Request com detalhes sobre a funcionalidade desenvolvida.

Utilize SemVer para controle de versão e definição das tags geradas. Para as versões disponíveis, observe as tags neste repositório.

As alterações devem conter testes de unidade e passar em todos os testes.