Inicio rápido¶

Esta página recorre la generación, ejecución y prueba de un proyecto nuevo de extremo a extremo.

1. Genera el proyecto¶

Bash

apogee new my-project
cd my-project

Produce un scaffold de 31 archivos.

2. Añade una entidad de dominio¶

Bash

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

Genera entidad, repositorio (puerto + implementación), casos de uso, ORM, router FastAPI y migración.

3. Ejecuta el proyecto¶

Bash

apogee up

Levanta app en el puerto 8000 y postgres en 5432. Visita http://localhost:8000/docs para la UI OpenAPI autogenerada.

4. Prueba la 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. Detén y limpia¶

Bash

apogee down              # detiene los contenedores
apogee down --volumes    # también elimina el volumen de la BD

Por dónde seguir¶

¿Autenticación? → módulo apogee-auth.
¿Chatbot o RAG? → módulo apogee-ai-rag.
¿Entender el diseño? → Conceptos.