academlo-auth-api-starter v1.0.3

Auth Para Cuando Starter

Este proyecto es un ejemplo de autenticación usando sequelize como ORM y un esquema básico y sencillo como DB

Ya maneja handlers de error y otros utils para poder escalar de manera viable

Installation

Para iniciar este proyecto solo asegurate de

Tener Node 18

Se asume que se usa Postgres como motor de base de datos

Tener las variables marcadas en el .env.example seteadas en el .env

Si tienes dudas para que sirven las que son de DATABASE_URI_ENV, en el notion Backend del proyecto existen explicaciones detalladas.

Una vez hecho eso, corre

  npm install

Y seguido de

  npm run start

o

  npm run dev

Dependiendo si el entorno es de desarrollo o no

Docker

Por default, ya seteamos el Dockerfile y funciona

Si correrás el proyecto con docker-compose solo encargate de setear las variables en el .env indicadas en el .env.example

Si se necesitas la base de datos que te damos de manera preterminada usando docker compose:

Tienes que indicar las variables que esta necesita para setearte la DB que están en el .env.db.docker.example al .env.db.docker

Hecho eso, con el siguiente commando estaría listo:

  docker-compose up

Existe una explicación en el notion del proyecto que explica el Dockerfile y docker-compose.yml