Esta API se encarga de manejar todo lo necesario para las reservas de las mesas en los diferentes restaurantes que maneja el sistema.
$ git clone https://github.com/comodinx/restaurants-manager-api.git
$ cd restaurants-manager-api
$ npm i
Para el correcto funcionamiento de la API, la misma, cuenta con un archivo .env.example
. En él se encuentran las configuraciones mínimas para poder correrla.
Para que levante dichas configuraciones, es necesario correr el siguiente comando,
$ cp .env.example .env
La base de datos esta pensada en MySQL. La misma se encuentra en el root del projecto, dentro de la carpeta database
.
# Instalar la base de datos en el entorno local, con las credenciales de conexión predeterminadas.
npm run db:install
#
# Instalar la base de datos con las credenciales de customizadas.
npm run db:install -- --host docker.mysql.host --user admin --pass 1234abcd
#
# o
DB_HOST=docker.mysql.host DB_USER=admin DB_PASS=1234abcd npm run db:install
#
# Para mas detalles, correr
npm run db:install -- --help
Valores por defecto
- DB Name ->
restaurants
- DB Host ->
localhost
- DB User ->
root
- DB User ->
WwFFTRDJ7s2RgPWx
Si ya realizo la configuración, recuerde configurar las variables de entorno del archivo .env
con los valores correctos. Luego ejecute uno de los siguientes comandos:
# Desarrollo
npm run dev
# Producción
npm run build && npm start
Van a poder encontrar la documentación de la API en este link
Para ver ejemplos más concretos, LOS INVITO A VER LAS PRUEBAS :)
npm test
💡 Para la solución de este ejercicio incluimos la carpeta `dist` para evitar compilaciones en la micro VM donde lo deployamos temporalmente para la demo.