Rede Cívica — Documentação
Copyright (C) 2026 Guilherme M. contato@redecivica.com.br This file is part of the Rede Cívica project, licensed under AGPL-3.0. See NOTICE.md.
Repositório de documentação do projeto Rede Cívica. Contém o modelo conceitual e as especificações de software. Não há código neste repositório.
O código do aplicativo vive em dois repositórios da org:
- mvp-api: back-end NestJS. Monolito modular “O Formigueiro”, orientado a eventos.
- mvp-web: front-end React, PWA map-first.
A documentação publicada está em docs.redecivica.com.br, com busca e leitura em celular e desktop. O site é gerado deste repositório: cada push no master reconstrói as páginas a partir dos arquivos daqui. O markdown deste repositório continua sendo a fonte única.
O projeto
Seção intitulada “O projeto”Infraestrutura cívica digital para governança social. Cidadãos registram demandas do território. O sistema categoriza e prioriza por parâmetros públicos. Conselheiros sorteados acompanham a execução. O processo inteiro é público e rastreável.
O modelo completo está em rede_civica.md. É a fonte da verdade deste repositório. Toda contribuição parte dessa leitura.
Por onde começar
Seção intitulada “Por onde começar”- rede_civica.md: o compilado definitivo do projeto, organizado em partes e seções.
- contexto_IA.md: resumo técnico-conceitual por tópico, para agentes de IA.
- mapa_e_tiles.md: introdução a mapas, formatos de dado e tiles, para quem chega sem conhecer o tema.
- infografico_formigueiro.pdf: guia visual da arquitetura, do fluxo da demanda e do conhecimento agregado. A fonte interativa é o infografico_formigueiro.html.
- sds/: especificações de software. Fichas das colônias, taxonomia e contratos.
- deploy.md: onde e como o MVP roda. CI/CD, VPS, componentes e operação.
- estatuto_empresa_socializada.md: estatuto da empresa socializada.
- politica_privacidade.md: política de privacidade exibida no aplicativo.
- rastros_conteudo.md: texto canônico dos rastros de conteúdo exibidos no aplicativo + anexo técnico de implementação.
Estrutura
Seção intitulada “Estrutura”| Caminho | Conteúdo |
|---|---|
| rede_civica.md | Compilado definitivo do modelo conceitual |
| contexto_IA.md | Resumo técnico-conceitual para agentes de IA |
| mapa_e_tiles.md | Guia de introdução a mapas, formatos de dado e tiles |
| infografico_formigueiro.html | Fonte do guia visual, com CSS de impressão por página |
| infografico_formigueiro.pdf | Guia visual renderizado, com uma página por infográfico |
| sds/ | Software Design Specification de cada colônia do Formigueiro |
| deploy.md | Arquitetura e operação do deploy (CI/CD, VPS, storage) |
| estatuto_empresa_socializada.md | Estatuto da empresa socializada |
| politica_privacidade.md | Política de privacidade exibida no aplicativo |
| rastros_conteudo.md | Texto canônico dos rastros de conteúdo exibidos no aplicativo e anexo técnico de implementação |
Para quem vai escrever código
Seção intitulada “Para quem vai escrever código”Os contratos de implementação estão nos SDS deste repositório. Cada repositório de código tem sua própria documentação de referência (AGENTS.md e README.md) no repo correspondente.
Contribuição
Seção intitulada “Contribuição”- Leia o AGENTS.md, com as regras de escrita e os protocolos de sincronização, e o CONTRIBUTING.md, com o fluxo de contribuição.
- Os textos conceituais e legais (rede_civica.md, contexto_IA.md e politica_privacidade.md) são mantidos pelo autor do projeto.
- Contribuições externas ficam no escopo técnico: sds/, deploy.md e correções de documentação.
- O CI roda markdownlint e verificação de links. Em local,
npm run verificarroda os dois checks. - Convivência: código de conduta da org, no repo
.github.
Licença
Seção intitulada “Licença”AGPL-3.0. O texto completo está no arquivo LICENSE da raiz.