/yourclock-backend-node

backend de pagina "your clock"

Primary LanguageJavaScript

yourclock-backend-node

Backend del proyecto your-clock basado en Node JS y en la arquitetura MVC (Modelo-Vista-Controlador)

Diagrama de la arquitectura MVC

MASTER DEV
Quality Gate Status Quality Gate Status
Coverage Coverage
building-and-deployment building-and-deployment-dev

Para configurar el proyecto en local:

  • Crear un archivo llamado .env tomando como ejemplo el archivo .env.example
  • Instalar las dependencias con npm install

Para iniciar el servidor en local:

  • Tener configurada la base de datos en local
  • Iniciar el servidor de redis local
  • Ejecutar el comando npm run start:dev

Para ejecutar los test unitarios:

  • Ejecutar el comando npm run test

    Si se desea ejecutar con coverage:

  • Ejecutar el comando npm run test:coverage

  • Se creara una carpeta llamada coverage en la raiz del proyecto la cual contendra un index.html con la informacion del coverage

Para crear la documentacion de las API's:

  • Instalar la dependencia global con npm install -g apidoc, si esta en Linux usar sudo
  • Ejecutar el comando apidoc -i src/controller/api -o src/controller/api/doc
  • Se creara una carpeta llamada doc dentro de la carpeta controller/api la cual contendra un index.html con la documentacion