Bem-vindo à Camada de Negócio do sistema ContaUp. Este repositório atua como o cérebro contábil da aplicação, garantindo através de regras estritas (DDD e Clean Architecture) que todas as transações financeiras e lançamentos sigam as normas técnicas de contabilidade, impedindo qualquer violação de integridade antes de tocar no banco de dados.
A documentação profunda e estrutural sobre como tudo funciona foi extraída para o nosso guia especializado.
👉 Leia nosso Guia de Arquitetura:
- ARQUITETURA.MD (Explica o Clean Architecture, Zod, Entidades, Tratamento de Erros e o fluxo do API Gateway com Nginx).
Nossa API possui uma documentação viva construída nativamente (servida diretamente na rota raiz /). Ao subir o servidor localmente ou em produção, basta acessar a URL base no navegador para visualizar o mapa completo de rotas, payloads, cabeçalhos de autenticação e códigos de erro.
- Node.js & Express: Roteamento e orquestração.
- TypeScript: Tipagem estrita para o domínio contábil.
- Zod: Validação de segurança no
req.body(Esquemas). - Supabase Client: Comunicação de persistência via Repositories.
-
Clone e Instale:
git clone https://github.com/seu-usuario/contap-backend.git cd contap-backend npm install -
Configuração de Ambiente: Copie ou crie o
.envcom as chaves do Supabase.SUPABASE_URL=sua_url SUPABASE_KEY=sua_service_role_key PORT=3001
-
Inicie o servidor (Dev):
npm run dev
-
Acesse
http://localhost:3001no navegador para ver a documentação interativa da API!
Para regras de commit e versionamento, siga o nosso Fluxo de Git.