Saltar al contenido principal

Instalación

  • Requerimientos antes de iniciar la api.

aviso

Para este punto se considera que ya fueron completados todos los datos de las variables de entorno como se indica en su página.

info

Por cada servicio se va a iniciar un servidor independiente, es decir, el entorno de consumidores va a funcionar independientemente del entorno de dashboard o del entorno de notificaciones y viceversa.


Listado de comandos disponibles

Como se usan los comandos?
pnpm <comando>
Ejemplo: pnpm dev

"start" -> Compila e Inicia todos los Servicios para Producción.
"dev" -> Inicia todos los Servicios en modo Desarrollo.
"dev:consumers" -> Inicia el Servicio de Consumidores en modo Desarrollo.
"dev:dashboard" -> Inicia el Servicio de Dashboard en modo Desarrollo.
"dev:notifications" -> Inicia el Servicio de Notificaciones en modo Desarrollo.
"test:route:auth" -> Prueba las rutas de autenticación.
"test:route:clients" -> Prueba las rutas de clientes.
"test:route:dispatchs" -> Prueba las rutas de despachos.
"test:route:merch" -> Prueba las rutas de merching.
"test" -> Realiza todos los tests.
"build" -> Compila la aplicación y deja los archivos finales en la carpeta "dist".
"tc" -> Comprueba el tipado del código typescript.
"pg" -> Genera el esquema de prisma.

Instalar los Paquetes

pnpm i

Generar Esquema de Prisma

Más detalles en la página dedicada.

pnpm pg

Inicio como Desarrollo

pnpm dev

Realizar pruebas automatizadas

pnpm test

Buildear para Llevar a Producción

pnpm build

Ejecutar versión buildeada

node dist/start.js

Puedes automatizar la build, el chequeo de tipado y la ejecución de la versión final con:

npm start
tip

Se recomienda utilizar npm para la puesta en producción al ser este nativo de nodejs.