API-Scardua/README.md
Ricardo Leite e6b5d10cbc 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 <noreply@anthropic.com>
2026-07-29 09:22:41 -03:00

26 lines
764 B
Markdown

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