Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,9 @@ composer update modules/<nome>
Tudo o que não cabe neste README fica em [`docs/`](docs/):

- [`produto.md`](docs/produto.md): visão, módulos do MVP e fases seguintes, decisões em aberto
- [`arquitetura/`](docs/arquitetura/): documento visual da arquitetura (PDF): tenancy por edição, módulos e como conversam, banco, papéis, fluxos de compra, CFP e dinheiro, segurança, telas
- [Design do admin](https://claude.ai/artifact/3B7ZWqjBQPDFZ5vhGgNs4N#page-dcb81aee8d83): protótipo/telas do `front-admin`
- ADRs com o porquê de cada decisão de arquitetura (a escrever)
- [`adr/`](docs/adr/): o porquê de cada decisão de arquitetura (0001–0009)
- Guia para a comunidade anfitriã: criar a edição, conectar o gateway, tematizar e abrir o CFP (a escrever)


Expand Down
4 changes: 4 additions & 0 deletions backend/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ Policy ou Gate de outro módulo confere permissão, nunca papel: `EditionMembers
- Segredo nunca vai pro repositório — ver `docs/adr/0006-politica-de-segredos.md`.
- Macro/bind que uma rota de módulo usa (ex.: `Route::apiV1()`) tem que ser registrada no `register()` do provider, nunca no `boot()` — o `internachi/modular` carrega as rotas de cada módulo num hook `booting()` que dispara antes do `boot()` de qualquer provider (inclusive do `AppServiceProvider`).

## Documento de arquitetura

`../docs/arquitetura/` tem o documento visual de como tudo se encaixa (PDF de 18 páginas gerado por `docs/arquitetura/fonte/gerar.py`). **Todo PR que muda a arquitetura atualiza o documento no mesmo PR**: módulo novo ou que deixa de ser casca, tabela, contrato ou ponto de extensão novo, papel ou permissão, rotina agendada, serviço externo, ou mudança de fluxo (compra, CFP, dinheiro, tenancy). Edite o `gerar.py` (os números estão escritos lá), atualize `RETRATO`, rode `python3 docs/arquitetura/fonte/gerar.py && node docs/arquitetura/fonte/imprimir.mjs` na raiz e confira as páginas com `imprimir.mjs <pasta>`. Ver `docs/arquitetura/README.md`.

## Comandos

```bash
Expand Down
Binary file added docs/arquitetura/PHPeste_Arquitetura.pdf
Binary file not shown.
56 changes: 56 additions & 0 deletions docs/arquitetura/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Arquitetura da PHPeste Platform

**[PHPeste_Arquitetura.pdf](PHPeste_Arquitetura.pdf)** (18 páginas, A4 paisagem). O mesmo conteúdo, para abrir no navegador: [`fonte/arquitetura.html`](fonte/arquitetura.html).

| Página | Conteúdo |
|--------|----------|
| 1 | Capa, resumo e legenda |
| 2 | Visão geral do sistema: painel, site, API, fila, banco, serviços externos |
| 3 | Tenancy: comunidade, edição como tenant e o que é global |
| 4 | Como uma requisição encontra a edição (rotas, middleware, jobs, eventos, host) |
| 5 | Ciclo de vida da edição, transições, clonagem e Visão geral |
| 6 | Os 15 módulos do backend |
| 7 | Como os módulos conversam: contratos e pontos de extensão |
| 8 | Banco de dados por domínio (65 tabelas) |
| 9 | Papéis e permissões |
| 10 | Ingresso: da compra ao QR |
| 11 | CFP: da proposta à grade |
| 12 | Dinheiro: patrocínio, fornecedores e finanças |
| 13 | Fila, rotinas agendadas, e-mail e auditoria |
| 14 | Segurança |
| 15 | Desenvolvimento, CI e deploy |
| 16 | Telas: o design do painel (`docs/design/`) |
| 17 | Telas: o painel em uso (capturas do front-admin) |
| 18 | Onde estamos e o que falta |

Retrato de 19/11/2026, main em `b4293b3`.

## Como atualizar

O documento é gerado: não edite o HTML nem o PDF à mão. Os diagramas são SVG escritos em `fonte/gerar.py`, e os números (tabelas, rotas, contratos, permissões) estão escritos lá. A partir da raiz do repositório:

```bash
python3 docs/arquitetura/fonte/gerar.py # gera fonte/arquitetura.html
node docs/arquitetura/fonte/imprimir.mjs # gera o PDF (usa o Playwright do front-admin/)
```

Para salvar também um PNG de cada página (bom para revisar o layout): `node docs/arquitetura/fonte/imprimir.mjs /tmp/paginas`.

Os prints do painel (`telas/`) saem do front-admin rodando com a API simulada:

```bash
cd front-admin && CAPTURAR_TELAS=1 npx playwright test e2e/capturas-arquitetura.spec.ts
```

Os números do documento conferem com o código assim:

```bash
cd backend
grep -ho "Schema::create('[a-z_]*'" app-modules/*/database/migrations/*.php database/migrations/*.php | sort -u | wc -l # tabelas
php artisan route:list --json | python3 -c "import sys,json; print(sum(1 for r in json.load(sys.stdin) if r['uri'].startswith('api/')))" # rotas da API
ls app-modules/*/src/Contracts/*.php | wc -l # contratos
```

## Quando atualizar

No mesmo PR que muda a arquitetura: módulo novo ou que deixa de ser casca, tabela nova, contrato ou ponto de extensão novo, papel ou permissão nova, rotina agendada nova, serviço externo novo, mudança de fluxo (compra, CFP, dinheiro), ou tela nova que valha um print. Atualize também a data e o commit em `RETRATO`, no topo do `gerar.py`.
Loading
Loading