Inicio rápido

Requisitos

• Node.js ≥ 20.19 para el CLI; el proyecto generado espera Node ≥ 24 (ver .nvmrc en el template)
• pnpm (gestor fijado del proyecto generado)

Recomendado

• Plugin Serena para trabajar con agentes de IA

Crear un proyecto

npx @carloscasteher/create-bb-app
# o
pnpm dlx @carloscasteher/create-bb-app

El wizard pide:

• nombre del proyecto (kebab-case)
• base de datos: postgres o mongo
• eventos de dominio: sí / no
• instalar dependencias: sí / no
• confirmación final

Scaffold in-place:

mkdir my-api && cd my-api
npx @carloscasteher/create-bb-app .

No interactivo (CI / scripts)

npx @carloscasteher/create-bb-app my-api --database=postgres --events --yes
npx @carloscasteher/create-bb-app my-api --database=mongo --events --skip-install --yes

Ver CLI y flags para el detalle.

Después del scaffold (Postgres)

cd my-api
pnpm install
pnpm docker:up
pnpm migration:run
pnpm start:dev

Después del scaffold (Mongo)

cd my-api
pnpm install
pnpm docker:up
pnpm start:dev

Por defecto la API escucha en http://localhost:3000.

Smoke check

curl http://localhost:3000/api/v1/health-check
# → It seems that everything is working fine!

Con events habilitados:

curl -X POST http://localhost:3000/api/v1/health-check/event-emit \
  -H 'content-type: application/json' \
  -d '{"message":"ping"}'
# → Event emitted

Con database (users):

curl -X POST http://localhost:3000/api/v1/users \
  -H 'content-type: application/json' \
  -d '{"name":"John","firstSurname":"Doe","secondSurname":"Doe","email":"john.doe@example.com","password":"Password1!"}'
# → 201 + UserDetailsDto

Swagger: http://localhost:3000/api/docs