Setup

Comentarios generales

Vamos a tener 2 bases de datos en un container de Docker. La primera la vamos a usar exclusivamente para el desarrollo (dev). Por el otro lado, la segunda la vamos a usar solo para ejecutar tests (test). Esto evita interferencia entre las bases de datos.

Docker

Seguir este tutorial para instalarlo en Ubuntu. Tambien pueden bajarse Docker Desktop usando este link.

.env

1. Crear un nuevo archivo en la carpeta backend que se llame .env y otro que se llame .env.test
2. Copiar los contenidos del archivo .env.template al archivo que creaste en el paso anterior
3. En el archivo .env asignar el puerto 5434 para PostgreSQL. Por el otro lado, en el archivo .env.test asignar el puerto 5435 para PostgreSQL. (en DATABASE_URL).
4. Reemplazar los valores entre "< >" por los que corresponda (espero que hayas guardado ese username y password 👀)

⚡ Quick start

🔌 Inicializar DB

En la consola correr el comando

yarn db:dev:up

🔄 Aplicar migraciones de Prisma

En la consola correr el comando

yarn prisma:dev:deploy

🚀 Como levantar el proyecto

Para levantar el proyecto:

yarn start

🧪 Como ejecutar los tests

Para ejecutar los tests, primero hay que inicializar la DB de test. Luego, ejecutamos el comando adecuado en base a que test queremos ejecutar (comandos)

📄 Documentacion relevante

• Documentacion oficial de NestJS
• Documentacion Prisma que es el ORM que vamos a estar usando.
• NestJS + Prisma
• Que es el .env???

📄 Comandos

yarn start

Para levantar el proyecto.

Flags opcionales:

• --watch: Permite levantar el proyecto en modo watch (cada vez que se hace un cambio en el codigo, se reinicia el proyecto).

yarn db:dev:up / yarn db:test:up

Levanta la base de datos de dev/test.

yarn db:dev:rm / yarn db:test:rm

Elimina la base de datos de dev/test.

yarn db:dev:restart / yarn db:test:restart

Elimina la base de datos de dev/test, luego la vuelve a crear y aplica las migraciones de Prisma.

yarn prisma:dev:deploy / yarn prisma:test:deploy

Aplica las migraciones de Prisma a la base de datos de dev/test.

yarn prisma generate

Si hicimos algun cambio al schema este comando actualiza prisma. Si ya corriste las migrations este comando ya se llamo.

yarn test

Correr tests.

yarn test:e2e

Correr tests end-to-end.

Flags opcionales:

• --watch: Permite correrlo en modo watch (los tests se ejecutan cada vez que se actualiza el codigo).

yarn prisma studio

Abrir prisma studio para visualizar la base de datos.