Skip to content

Repository files navigation

Sinapse — Base Inteligente de Requisitos

PRO4TECH · Fatec São José dos Campos · Grupo Galáticos
Projeto de Aprendizagem Interdisciplinar (API) — 4º Semestre (2º Semestre/2026)

O Sinapse é a memória institucional da fábrica de software. A plataforma converte itens de backlog, regras de negócio e decisões de arquitetura em uma base de conhecimento inteligente, auxiliando Product Owners (POs) e equipes de desenvolvimento na especificação padronizada de features, redução de retrabalho e reúso de conhecimento prévio.


📚 Documentação Canônica do Projeto

Toda a especificação técnica, backlog e decisões arquiteturais estão estruturados nos documentos oficiais abaixo:

Documento Descrição e Conteúdo
📄 PRD — Product Requirements Document Requisitos funcionais (RF), não-funcionais (RNF), regras de negócio e governança de IA.
🏛️ Arquitetura e Modelagem de Dados Diagramas de componentes, fluxo de RAG, diagrama ERD e fronteiras entre camadas.
🤖 Contexto Canônico de IA e Agentes Regras não-negociáveis para agentes autônomos e desenvolvedores (assistência estrita, proveniência e isolamento).
🛠️ Guia de Configuração e Ambiente Passo a passo de instalação local de todas as stacks, variáveis de ambiente e portas padrão.
📋 Backlog de Produto (66 PBIs) Especificação completa dos 6 épicos e 18 features no padrão da fábrica.
📅 Plano de Tarefas e Execução Técnica Detalhamento operacional das 71 tarefas técnicas, estimativas, dependências e status real das PREs.
📊 Planejamento Scrum por Sprint Metas executivas de entrega divididas entre Sprint 1, 2 e 3.
🔬 Spike Técnico: Embeddings PT-BR Relatório de validação do modelo BAAI/bge-m3 (1024 dimensões) e índice HNSW no pgvector.
🔌 Contrato OpenAPI (Serviços) Especificação dos endpoints e schemas HTTP compartilhados entre backend, IA e n8n.

🏗️ Arquitetura e Componentes de Infraestrutura

O ecossistema é distribuído em microsserviços conteinerizados e locais:

Componente Tecnologia Porta Local Responsabilidade Principal
Banco Unificado PostgreSQL 16 + pgvector 55432 (host) Dados relacionais de negócio e vetores de chunks indexados por HNSW (vector_cosine_ops).
Orquestrador n8n (latest) 5678 Pipeline assíncrono de ingestão, gatilhos de arquivos em /files e integrações.
Runtime de IA Ollama 11434 Inferência local de LLM (qwen2.5:1.5b) e geração de embeddings (bge-m3).
Backend Node.js 20+ / Express / TS 3001 Autenticação JWT, CRUD, validações determinísticas (RF-08 a RF-11) e única escrita no banco de negócio.
Frontend React 19 / Vite / TS 5173 SPA para Product Owners (gestão hierárquica de PBIs, acervo e chat fundamentado).
Serviço de IA Python 3.11+ / FastAPI 8000 Chunking unificado, cálculo de vetores, Harness PRO4TECH e montagem de contexto RAG.

🚀 Inicialização Rápida

1. Pré-requisitos

2. Configurar Variáveis de Ambiente

cp .env.example .env

⚠️ Importante: Mantenha N8N_ENCRYPTION_KEY=sinapse-shared-dev-encryption-key-2026 em ambiente de desenvolvimento local para compatibilidade com os workflows versionados.

3. Subir a Infraestrutura Base

docker compose up -d

Serviços disponíveis:

Para encerrar os serviços sem apagar os dados persistidos:

docker compose down

4. Baixar Modelos Locais no Ollama (opcional)

docker compose --profile local-ai up -d

# Modelo de Embeddings PT-BR (validado no Spike PRE-07)
docker compose --profile local-ai exec ollama ollama pull bge-m3

# Modelo LLM para inferência rápida local (CPU)
docker compose --profile local-ai exec ollama ollama pull qwen2.5:1.5b

🔄 Versionamento de Workflows (n8n-local-sync)

Os workflows do n8n são versionados no Git via utilitário GitOps n8n-local-sync:

# Instalação
pip install n8n-local-sync

# Principais comandos
n8n-sync status     # Visualiza estado de sincronização local vs n8n
n8n-sync diff       # Compara diferenças estruturais limpas
n8n-sync sync       # Puxa workflows do container para o Git (n8n/workflows/)
n8n-sync push       # Envia workflows do Git para a instância do n8n
n8n-sync validate   # Valida integridade do JSON e detecta segredos expostos

🧪 Comandos de Validação e Qualidade

Verificação Comando Descrição
Validação Docker docker compose config --quiet Checa a sintaxe do Compose
Workflows n8n n8n-sync validate Varre sintaxe e credenciais expostas
Migrations cd backend && npm run migrate Executa migrations pendentes no Postgres
Testes Backend cd backend && npm test Executa suíte de testes unitários/integração
Validação integrada S1 cd backend && npm run test:integration:s1 Valida os fluxos HTTP com PostgreSQL real da Sprint 1
Auditoria de Segurança cd backend && npm run audit:security Verifica dependências de produção
Tipagem Backend cd backend && npm run typecheck Checagem estrita de tipos TypeScript
Testes Frontend cd frontend && npm test Executa a suíte Vitest da interface
Build Frontend cd frontend && npm run build Valida bundle de produção da SPA
Testes do serviço de IA cd ai-service && python -m unittest discover -s tests Executa os testes do chunker e metadados

📁 Estrutura de Diretórios

API-4/
├── .github/workflows/         # Pipelines de CI/CD no GitHub Actions
├── ai-service/                # Microsserviço Python/FastAPI (RAG, Chunking & Ollama)
├── backend/                   # API REST Node.js/TypeScript (CRUD, Auth & Postgres)
├── database/                  # DDL de inicialização, migrations e seeds
│   ├── init.sql               # Schema DDL inicial
│   ├── migrations/            # Migrations versionadas em SQL
│   └── seed/                  # Carga de dados fictícios para desenvolvimento
├── docs/                      # Documentação canônica consolidada
│   ├── Architecture/          # Diagramas de arquitetura, fluxo RAG e ERD
│   ├── PRD-PRO4TECH.md        # Especificação técnica e requisitos funcionais
│   ├── backlog/               # Mapeamento dos 6 épicos e 66 PBIs
│   ├── PLANO_DE_TAREFAS_DESENVOLVIMENTO.md # Plano detalhado e status
│   ├── api/                   # Contrato OpenAPI (openapi.yaml)
│   ├── AGENTS.md              # Diretrizes canônicas para agentes e LLMs
│   ├── PLANEJAMENTO_SCRUM.md  # Organização das tarefas de desenvolvimento
│   ├── SETUP_GUIDE.md         # Guia de configuração e desenvolvimento
│   └── Spike Embeddings.md    # Relatório técnico do Spike PRE-07
├── frontend/                  # SPA React 19/TypeScript/Vite (Interface do PO)
├── n8n/                       # Workflows exportados e arquivos locais monitorados
├── scripts/                   # Utilitários e benchmarks (spike_embeddings.py)
├── .env.example               # Template de variáveis de ambiente
├── .n8n-sync.yaml             # Configuração do n8n-local-sync
└── docker-compose.yml         # Orquestração local (PostgreSQL + pgvector, n8n & Ollama)

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages