Despachante Bortone — Banco de Dados

Bem-vindo à documentação do banco de dados do sistema Despachante Bortone. Este portal concentra todas as informações técnicas sobre a modelagem, configuração e uso do banco de dados do projeto.

Projeto Acadêmico — Desenvolvido pela turma da FATEC Registro para o Laboratório de Práticas 2026-1.

Repositório: laboratorio-de-praticas-2026-1/database

🚀 Início Rápido

Para Desenvolvedores

🗄️ Modelagem do Banco de Dados - ⭐ Tabelas, ENUMs, relacionamentos e diagrama
⚙️ Configuração do Ambiente - Docker, variáveis de ambiente, Prisma e seed
📋 Histórico de Migrações - Todas as alterações aplicadas no schema

Para novos membros do time

🌱 Dados Iniciais (Seed) - Dados de exemplo para popular o banco em desenvolvimento

📚 Documentação por Área

🗄️ Banco de Dados

O banco de dados suporta uma aplicação web de um escritório de despachante, onde clientes solicitam serviços de documentação veicular (licenciamento, transferência de propriedade, renovação de CNH etc.).

Modelagem do Banco de Dados - ⭐ Estrutura completa: tabelas, ENUMs e relacionamentos
Configuração do Ambiente - Setup do Docker, Prisma e variáveis de ambiente
Dados Iniciais (Seed) - Registros de exemplo para desenvolvimento e testes
Histórico de Migrações - Evolução do schema com o SQL de cada migração

🔧 Tecnologias Utilizadas

Tecnologia	Versão	Função
MySQL	8.0	SGBD principal (container Docker)
Prisma	7.x	ORM e gerenciamento de migrações
@prisma/adapter-mariadb	7.x	Adapter de conexão MariaDB/MySQL
TypeScript	5.x	Linguagem do schema e seed
Docker Compose	—	Orquestração do container do banco

🛠️ Configuração do Ambiente

Executar a Documentação Localmente

Instalar dependências do MkDocs:

pip install mkdocs mkdocs-material

Navegar para a pasta de documentação:

cd documentacao/

Executar o servidor local:

mkdocs serve

Acessar no navegador:
```
http://127.0.0.1:8000
```

Estrutura da Documentação

documentacao/
├── docs/
│   ├── assets/          # Imagens e recursos estáticos
│   ├── stylesheets/     # Estilos customizados (CSS)
│   ├── index.md         # Esta página
│   ├── configuracao.md  # Setup do ambiente
│   ├── modelagem.md     # Modelagem do banco de dados
│   ├── seed.md          # Dados iniciais
│   └── migracoes.md     # Histórico de migrações
└── mkdocs.yml           # Configuração da navegação

🤝 Contribuindo

Encontrou algo desatualizado ou quer contribuir com a documentação?

Abra uma issue descrevendo o problema ou melhoria
Crie um Pull Request com suas alterações na branch adequada
Após o merge, rode mkdocs gh-deploy para atualizar o site

📋 Status da Documentação

Seção	Status	Última Atualização
Modelagem do Banco de Dados	✅ Completo	Mar 2026
Configuração do Ambiente	✅ Completo	Mar 2026
Dados Iniciais (Seed)	✅ Completo	Mar 2026
Histórico de Migrações	✅ Completo	Mar 2026

Para dúvidas específicas, consulte a documentação correspondente ou abra uma issue no repositório.