Giter VIP home page Giter VIP logo

restaurants-manager-api's Introduction

API Restaurantes

Esta API se encarga de manejar todo lo necesario para las reservas de las mesas en los diferentes restaurantes que maneja el sistema.

Index

Descargar

Código fuente

$ git clone https://github.com/comodinx/restaurants-manager-api.git
$ cd restaurants-manager-api
$ npm i

(ir arriba)

Configuraciones

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

(ir arriba)

Base de datos

La base de datos esta pensada en MySQL. La misma se encuentra en el root del projecto, dentro de la carpeta database.

Instalar DB

# 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

(ir arriba)

¿Cómo se corre?

Correr

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

(ir arriba)

Documentación de la API

Van a poder encontrar la documentación de la API en este link

(ir arriba)

Tests

Para ver ejemplos más concretos, LOS INVITO A VER LAS PRUEBAS :)

Ejecutar las pruebas unitarias

npm test

(ir arriba)

💡 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.

restaurants-manager-api's People

Contributors

comodinx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.