Começo

Introdução ao NoteBugs

Um quadro Kanban local, em Docker, com os dados no seu PostgreSQL, e uma API HTTP inteira por trás dele.

O NoteBugs é um quadro Kanban para centralizar e validar projetos internos. Ele roda inteiro em Docker, guarda tudo num PostgreSQL que é seu e não depende de nenhum serviço externo para funcionar: nem para anexar um print, nem para gerar um backup.

Esta documentação tem duas metades. A primeira descreve o que o produto faz, funcionalidade por funcionalidade. A segunda é a referência da API: toda rota, com os campos que ela aceita, exemplos de requisição em cURL e TypeScript, a resposta de sucesso e as recusas possíveis.

O modelo mental

Quase tudo no NoteBugs decorre de uma hierarquia curta, e conhecê-la explica a maior parte da API:

espaço de trabalho (tenant)
  ├── card ────────────── a entidade de primeiro nível
  ├── projeto ─── epic ── o epic herda o espaço do projeto
  ├── etiqueta
  └── coluna
          └── comentário · anexo · histórico · vínculo

O card é a entidade de primeiro nível. projectId é anulável: projeto é rótulo de filtro, não dono. Quem isola é o espaço de trabalho.
`tenantId` é imutável. Card, projeto, etiqueta e coluna nascem dentro de um espaço e nunca saem dele: nenhum schema de edição aceita esse campo.
O epic é a única exceção: ele não carrega o espaço, herda o do projeto. Por isso é a única criação que não pede tenantId.

Por onde começar

Guia de início rápido

Subir o container, criar a primeira conta, gerar um token e fazer a primeira chamada.

Autenticação

Sessão em cookie, token Bearer, os dois eixos de papel e o limite de requisições.

Visão geral do sistema

Como a aplicação está montada e onde cada regra de negócio é aplicada.

Convenções da API

O que vale para TODA rota: validação, formato de erro, lote e confirmação.

Os exemplos apontam para localhost

Toda chamada desta documentação usa http://localhost:3000, que é onde o Compose publica a aplicação. Numa instalação atrás de um proxy, troque só o host, e nada mais muda.