From e6b5d10cbcaaf6f8665a13b5d23182260df425f4 Mon Sep 17 00:00:00 2001 From: Ricardo Leite Date: Wed, 29 Jul 2026 09:22:41 -0300 Subject: [PATCH] Adiciona README.md com visao geral e links pra docs Tambem resolve a referencia readme = README.md do pyproject.toml. Co-Authored-By: Claude Opus 4.8 --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c7e0d46 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# API-Scardua + +API FastAPI de integração da **Scardua** com serviços externos (Holmes, Apollo) e banco **Oracle**. + +🌐 No ar: **https://api-scardua.flstecnologia.tech** + +## Documentação + +| Doc | Assunto | +|-----|---------| +| [docs/arquitetura.md](docs/arquitetura.md) | Visão, atores e roadmap do projeto | +| [docs/deploy.md](docs/deploy.md) | Runbook de deploy (Podman/Quadlet/Caddy) | +| [docs/known-issues.md](docs/known-issues.md) | Problemas conhecidos e TODOs | +| [CLAUDE.md](CLAUDE.md) | Guia rápido do código | + +## Rodar local (Windows) + +Precisa do `configs.json` na raiz — veja `configs.example.json`. + +``` +uvicorn main:app --reload --port 8000 +``` + +## Stack + +Python ≥3.10 · FastAPI + Uvicorn · Pydantic v2 · httpx · oracledb (thin mode)