Esta plataforma foi desenvolvida para facilitar a criação, organização e manutenção de documentação técnica em projetos de software. Aqui você encontrará:

🎯 Objetivos do Projeto

O GuiaDev visa resolver os principais desafios na criação de documentação técnica:

• Reduzir o tempo necessário para criar documentação de qualidade
• Padronizar a estrutura e formato dos documentos técnicos
• Facilitar a colaboração entre desenvolvedores e technical writers
• Manter a documentação sempre atualizada e sincronizada

🛠️ Stack Tecnológica

• Frontend: React + JavaScript + Vite
• Backend: NestJS com TypeScript
• Database: PostgreSQL via Supabase
• Deploy: Vercel (front) + Railway/Render (back)

Visão Geral

O GuiaDev utiliza uma arquitetura simples, priorizando produtividade e facilidade de manutenção.

Stack Tecnológica

• Frontend: React + JavaScript + Vite
• Backend API: NestJS (Node.js framework)
• Banco de Dados: PostgreSQL via Supabase
• ORM: Prisma para type-safe database access

Vantagens da Stack Escolhida

• NestJS: Arquitetura modular, decorators, injeção de dependência
• Supabase: Backend-as-a-Service com PostgreSQL real-time
• TypeScript: Type safety em todo o stack
• Simplicidade: Sem complexidade desnecessária de websockets ou AWS

Comunicação API

A aplicação utiliza REST API com endpoints bem definidos. Para funcionalidades real-time futuras, podemos utilizar Supabase Realtime (baseado em PostgreSQL LISTEN/NOTIFY).

Deploy e Hosting

• Frontend: Vercel ou Netlify
• Backend: Railway, Render ou Digital Ocean
• Database: Supabase (hosting gerenciado)

Autenticação

Utilizamos Supabase Auth com JWT tokens. Inclua o token no header:

Authorization: Bearer {your-jwt-token}

Endpoints de Auth

POST /auth/register    # Registro de usuário
POST /auth/login       # Login
POST /auth/logout      # Logout
GET  /auth/profile     # Perfil do usuário

Documentos

GET    /documents           # Listar documentos
POST   /documents           # Criar documento
GET    /documents/:id       # Buscar documento
PUT    /documents/:id       # Atualizar documento
DELETE /documents/:id       # Deletar documento
POST   /documents/:id/share # Compartilhar documento

Projetos/Sprints

GET    /projects           # Listar projetos
POST   /projects           # Criar projeto
GET    /projects/:id       # Buscar projeto
PUT    /projects/:id       # Atualizar projeto
GET    /projects/:id/sprints # Listar sprints do projeto
POST   /projects/:id/sprints # Criar sprint

Exemplo de Resposta

{
  "success": true,
  "data": {
    "id": "uuid",
    "title": "Documento de Sprint",
    "content": "# Sprint 1...",
    "created_at": "2025-01-15T10:00:00Z",
    "updated_at": "2025-01-15T10:00:00Z",
    "author": {
      "id": "uuid",
      "name": "João Silva",
      "email": "joao@email.com"
    }
  },
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 10
  }
}