Início rápido¶

Esta página percorre a geração, execução e exercício de um projeto novinho ponta-a-ponta.

1. Gere o projeto¶

Bash

apogee new my-project
cd my-project

Produz um scaffold de 31 arquivos:

Text Only

my-project/
├── docker-compose.yml
├── Dockerfile.dev
├── alembic.ini
├── src/
│   ├── domain/
│   ├── application/
│   ├── infrastructure/
│   └── presentation/
├── migrations/
├── tests/
└── apogee.yml

2. Adicione uma entidade de domínio¶

Bash

apogee make:entity Customer \
  --field name:str \
  --field email:str \
  --field active:bool=true

Gera entidade, repositório (porta + implementação), use cases, ORM, router FastAPI e migration.

3. Rode o projeto¶

Bash

apogee up

Sobe app na porta 8000 e postgres na 5432. Visite http://localhost:8000/docs para a UI OpenAPI auto-gerada.

4. Exercite a API¶

Bash

curl -X POST http://localhost:8000/customers \
  -H 'Content-Type: application/json' \
  -d '{"name": "Ada Lovelace", "email": "ada@example.com"}'

curl http://localhost:8000/customers

5. Pare e limpe¶

Bash

apogee down              # para os containers
apogee down --volumes    # também remove o volume do banco

Por onde seguir¶

Quer adicionar autenticação? → veja o módulo apogee-auth.
Quer chatbot ou RAG? → veja o módulo apogee-ai-rag.
Quer entender o design? → Conceitos.