docs: Add technical manual, sales manual, and architecture diagram

This commit is contained in:
2026-02-09 11:56:08 -03:00
parent 4122dc6f3b
commit 1056c215df
6 changed files with 322 additions and 0 deletions

78
docs/ARQUITETURA.md Normal file
View File

@@ -0,0 +1,78 @@
# Arquitetura - DuOrigin v2
## Visão Geral
```
┌─────────────────────────────────────────────────────────────────────────────┐
│ CLIENTE (Browser) │
│ ┌─────────────────────────────────────────────────────────────────────┐ │
│ │ Next.js Frontend (React) │ │
│ │ Port: 3000 │ │
│ │ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │ │
│ │ │ Dashboard │ │ Producers │ │Declarations │ │ Maps │ │ │
│ │ └─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘ │ │
│ └─────────────────────────────────────────────────────────────────────┘ │
└────────────────────────────────────┬────────────────────────────────────────┘
│ REST API
┌─────────────────────────────────────────────────────────────────────────────┐
│ NestJS Backend │
│ Port: 3001 │
│ ┌─────────────────────────────────────────────────────────────────────┐ │
│ │ MODULES │ │
│ │ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │ │
│ │ │ Auth │ │ Producers │ │Declarations│ │ Geo │ │ │
│ │ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │ │
│ │ ┌───────────┐ ┌───────────┐ │ │
│ │ │ EUDR │ │ Reports │ │ │
│ │ │ API │ │ │ │ │
│ │ └───────────┘ └───────────┘ │ │
│ └─────────────────────────────────────────────────────────────────────┘ │
│ │ │
└──────────────────────────────┼──────────────────────────────────────────────┘
┌────────────────────┼────────────────────┐
│ │ │
▼ ▼ ▼
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ PostgreSQL │ │ API EUDR UE │ │ Map Services │
│ (Prisma) │ │ (SOAP/WSDL) │ │ (Leaflet) │
│ │ │ │ │ │
│ • Users │ │ • Submit DDS │ │ • Tile layers │
│ • Producers │ │ • Check status │ │ • Geo validate │
│ • Declarations │ │ • Get feedback │ │ │
│ • Parcels │ │ │ │ │
└─────────────────┘ └─────────────────┘ └─────────────────┘
```
## Fluxo EUDR
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ Cadastro │────▶│ Georrefe- │────▶│ Gerar │────▶│ Submeter │
│ Produtor │ │ renciamento │ │ Declaração │ │ à UE │
└─────────────┘ └─────────────┘ └─────────────┘ └──────┬──────┘
┌─────────────┐
│ Compliance │
│ ✓ │
└─────────────┘
```
## Stack
```
┌─────────────────────────────────────────────────────────────────┐
│ STACK TECNOLÓGICO │
├─────────────────────────────────────────────────────────────────┤
│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │
│ │ Next.js │ │ NestJS │ │ Prisma │ │PostgreSQL │ │
│ │ (Frontend)│ │ (Backend) │ │ (ORM) │ │ (DB) │ │
│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │
│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │
│ │ Leaflet │ │ JWT │ │ Tailwind │ │TypeScript │ │
│ │ (Maps) │ │ (Auth) │ │ (CSS) │ │ │ │
│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │
└─────────────────────────────────────────────────────────────────┘
```
---
*Diagrama gerado em 2026-02-09*

BIN
docs/ARQUITETURA.pdf Normal file

Binary file not shown.

131
docs/Manual-Tecnico.md Normal file
View File

@@ -0,0 +1,131 @@
# Manual Técnico - DuOrigin v2
## 1. Visão Geral
DuOrigin v2 é um sistema de compliance EUDR (EU Deforestation Regulation) para o agronegócio, desenvolvido com stack moderna e integração com APIs oficiais da União Europeia.
## 2. Stack Tecnológico
| Camada | Tecnologia | Versão |
|--------|------------|--------|
| Frontend | Next.js | Latest |
| Backend | NestJS | Latest |
| ORM | Prisma | 5.22.0 |
| Database | PostgreSQL | Latest |
| Auth | JWT (jose) | 5.10.0 |
| Maps | Leaflet | Latest |
| Estilização | TailwindCSS | Latest |
## 3. Estrutura do Projeto
```
duorigin-v2/
├── frontend/ # Next.js App
├── backend/ # NestJS API
│ ├── src/
│ │ ├── modules/ # Feature modules
│ │ └── main.ts
│ └── package.json
├── prisma/
│ ├── schema.prisma # Database schema
│ └── seed.ts # Data seeding
├── src/ # Shared types/utils
├── public/
├── package.json
└── docker-compose.yml
```
## 4. Funcionalidades
### 4.1 Compliance EUDR
- Declarações de due diligence
- Rastreabilidade de commodities
- Geolocalização de parcelas
- Validação de cadeia produtiva
### 4.2 Gestão de Produtores
- Cadastro de produtores rurais
- Documentação de propriedades
- Certificados e licenças
### 4.3 Geolocalização
- Mapeamento de áreas produtivas
- Integração com mapas (Leaflet)
- Validação de coordenadas GPS
### 4.4 Integração API EUDR
- Conexão com sistema da UE (SOAP/WSDL)
- Submissão de declarações
- Consulta de status
## 5. API Endpoints (NestJS)
### 5.1 Autenticação
```
POST /api/auth/login
POST /api/auth/register
GET /api/auth/me
```
### 5.2 Produtores
```
GET /api/producers
POST /api/producers
PUT /api/producers/:id
DELETE /api/producers/:id
```
### 5.3 Declarações EUDR
```
GET /api/declarations
POST /api/declarations
POST /api/declarations/:id/submit
GET /api/declarations/:id/status
```
### 5.4 Geolocalização
```
POST /api/geo/validate
GET /api/geo/parcels/:producerId
```
## 6. Database Schema (Prisma)
### Principais Modelos
- User (Usuários do sistema)
- Producer (Produtores rurais)
- Declaration (Declarações EUDR)
- Parcel (Parcelas georreferenciadas)
- Commodity (Commodities rastreadas)
## 7. Requisitos de Sistema
- Node.js >= 18.x
- PostgreSQL >= 14
- npm >= 9.x
## 8. Instalação
```bash
# Instalar dependências
npm install
cd backend && npm install
# Configurar banco
cp .env.example .env
npm run db:generate
npm run db:push
npm run db:seed
# Iniciar desenvolvimento
npm run dev # Frontend
cd backend && npm run start:dev # Backend
```
## 9. Variáveis de Ambiente
```env
DATABASE_URL=postgresql://user:pass@localhost:5432/duorigin
JWT_SECRET=your-secret-key
EUDR_API_URL=https://api.eudr.eu
EUDR_API_KEY=xxx
```
---
*Documento gerado em 2026-02-09*

BIN
docs/Manual-Tecnico.pdf Normal file

Binary file not shown.

113
docs/Manual-Vendas.md Normal file
View File

@@ -0,0 +1,113 @@
# Manual de Vendas - DuOrigin v2
## 1. O Produto
**DuOrigin v2** é a solução definitiva para compliance EUDR no agronegócio brasileiro, permitindo exportação para a União Europeia com total conformidade regulatória.
## 2. Proposta de Valor
### O Problema EUDR
A partir de 2025, exportadores de commodities para UE precisam:
- Provar que produtos não vêm de áreas desmatadas
- Georreferenciar todas as parcelas produtivas
- Submeter declarações de due diligence
- Manter rastreabilidade completa
### Penalidades
- Multas de até 4% do faturamento global
- Proibição de exportação
- Danos reputacionais
### A Solução DuOrigin v2
- Compliance automatizado end-to-end
- Integração direta com API oficial da UE
- Georreferenciamento preciso
- Rastreabilidade completa da cadeia
## 3. Público-Alvo
### 3.1 Exportadores de Commodities
- Soja, Café, Cacau
- Madeira, Borracha
- Carne Bovina, Couro
### 3.2 Tradings
- Grandes traders (Cargill, ADM, Bunge)
- Traders regionais
### 3.3 Cooperativas
- Cooperativas agrícolas
- Associações de produtores
### 3.4 Frigoríficos
- Exportação de carne bovina
- Compliance de toda a cadeia
## 4. Funcionalidades
### 📍 Georreferenciamento
Mapeamento preciso de todas as parcelas produtivas com validação GPS.
### 📄 Declarações EUDR
Geração automática de declarações no formato exigido pela UE.
### 🔗 Rastreabilidade
Cadeia completa do produtor ao exportador.
### 🌍 API UE Integrada
Submissão direta ao sistema europeu.
### 📊 Dashboard
Visão consolidada de compliance por produtor/commodity.
### ⚠️ Alertas
Notificações de problemas e prazos.
## 5. Commodities EUDR Cobertas
| Commodity | Obrigatório |
|-----------|-------------|
| Soja | ✅ |
| Café | ✅ |
| Cacau | ✅ |
| Madeira | ✅ |
| Borracha | ✅ |
| Óleo de Palma | ✅ |
| Carne Bovina | ✅ |
| Couro | ✅ |
## 6. Diferenciais
| Feature | DuOrigin v2 | Concorrentes |
|---------|-------------|--------------|
| API UE Integrada | ✅ Nativa | Parcial |
| Georreferenciamento | ✅ Completo | Básico |
| Multi-commodity | ✅ | Limitado |
| Self-hosted | ✅ | Cloud only |
| Português | ✅ | Inglês |
## 7. Casos de Uso
### Caso 1: Trader de Soja
> "Exportamos 500mil ton/ano para UE. DuOrigin automatizou compliance que levaria meses para uma equipe de 10 pessoas."
### Caso 2: Cooperativa de Café
> "Nossos 2.000 produtores agora têm todas parcelas georreferenciadas. Zero risco de perder acesso ao mercado europeu."
## 8. ROI
| Cenário | Sem DuOrigin | Com DuOrigin |
|---------|--------------|--------------|
| Equipe dedicada | 10 pessoas | 2 pessoas |
| Tempo por declaração | 2 dias | 2 horas |
| Risco de multa | Alto | Zero |
| Exportação garantida | Incerta | ✅ |
## 9. Compliance Garantido
- ✅ Formato oficial UE
- ✅ Validação de coordenadas
- ✅ Audit trail completo
- ✅ Integração API certificada
---
*DuOrigin v2 — Exporte para UE sem Preocupações*

BIN
docs/Manual-Vendas.pdf Normal file

Binary file not shown.