Skip to content

Contrasync - Documentação de Arquitetura

Documentação técnica organizada por funcionalidade.


Índice

Essenciais

DocumentoDescrição
Code StyleLEIA PRIMEIRO - Padrões de código, clean code, nomenclatura
Project StructureStack tecnológico, estrutura de pastas, scripts

Arquitetura

DocumentoDescrição
Domain LayerCamada de domínio, types, constants, utils
RoutingRoteamento, layout de páginas, navegação
State ManagementGerenciamento de estado com Pinia
ServicesCamada de serviços e chamadas de API
Capabilities FrameworkAutonomia da Zelor: catálogo de capabilities (yml + mapper) que a IA dirige

UI/UX

DocumentoDescrição
StylingTailwind, SCSS, dark mode, i18n
Design SystemCards, cores, componentes Naive UI

Features

DocumentoDescrição
Data & APIsRegras de dados, mocks, JSON Server
AuthenticationOAuth, login social, fluxos de auth
Templates ModuleEndpoints, types, stores do módulo templates
HTML Template MigrationMigração do fluxo de upload de PDF para DOCX
Toolbar ActionsAções da toolbar de contratos
Contract Save FlowFluxo de salvamento e progressão de steps

Quick Start

  1. Leia o Code Style antes de escrever qualquer código
  2. Entenda a Project Structure para navegar no projeto
  3. Consulte os documentos específicos conforme necessidade