Adiciona README.md com visao geral e links pra docs #1

Merged
ricardo-leite merged 1 commit from add-readme into main 2026-07-29 12:40:16 +00:00
Showing only changes of commit e6b5d10cbc - Show all commits

26
README.md Normal file
View file

@ -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)