Skip to content

README (Public Documentation Copy)

Esta é uma cópia sanitizada do README.md da raiz, publicada no portal de documentação.

📚 Enterprise Documentation Engine

  • Wiki pública oficial: https://docs.spokeplus.com.
  • Toda alteração estrutural exige atualização dos arquivos em /docs.
  • O snapshot de schema (docs/schema/latest-schema.json e docs/schema/latest-schema.md) é regenerado por scripts/generate-schema-snapshot.js.
  • PR é inválido se mudanças estruturais não atualizarem documentação.

🛡 Regras de Governança Técnica (obrigatórias)

  • Não alterar portas (3000 API / 3001 Web).
  • Não alterar estrutura do PM2.
  • Não remover rotas existentes.
  • Não remover tabelas existentes.
  • Nunca usar SERVICE_ROLE no frontend.

📦 Arquitetura Geral

  • API backend: Express (server.js + app.js).
  • Web admin: Next.js App Router (16.2.2) + React 19.2.x.
  • Banco/Auth: Supabase (Postgres + Auth).
  • PM2 monitorado por endpoints de sistema.

Baseline validado de operação (servidor)

  • Node 24.14.1
  • npm 11.11.0
  • web/proxy.ts como arquivo de borda principal (em vez de middleware.ts)
  • web/tsconfig.json com "jsx": "react-jsx"
  • Lint web validado com cd web && npx eslint . --max-warnings=0
  • Build web validado com cd web && npx next build --webpack

🗄 Banco de Dados (snapshot)

A fonte pública de schema fica em:

  • docs/schema/latest-schema.json
  • docs/schema/latest-schema.md

🔗 Documentos principais