Giter Club home page Giter Club logo

grupo-n-9's Introduction

Backend Node Template

✅ Primero lo primero: instalar las dependencias iniciales del proyecto antes de trabajar

npm install

🚩 Recomendaciones

Utilizar la versión de Node v14.x

💡 El proyecto utliza Sequelize como ORM. Comandos utiles del CLI

Como generar un modelo desde cero

npx sequelize model:generate --name Ejemplo --attributes ejemplo:string

Crear la base de datos

npx sequelize db:create

Migrar modelos creados previamente

npx sequelize db:migrate

Borrar la base de datos que creamos

npx sequelize db:drop

Popular base de datos

  1. npx sequelize db:drop

  2. npx sequelize db:create

  3. npx sequelize db:migrate

  4. npx sequelize-cli db:seed:all

Despopular base de datos

  1. npx sequelize-cli db:seed:undo:all

  2. npx sequelize db:drop

Si se quiere despopular una sola semilla se puede usar

npx sequelize-cli db:seed:undo nombre de la semilla

Ver los usuarios disponibles

Ver archivo users.json

🏗 Algunos datos del proyecto

  • La estructura de carpetas es del patron MVC
  • Las respuestas positivas las devuelve como un objecto. Las negativas las gestiona como un HTML
  • En el proyecto encontrarán un ejemplo de como se implementa el flujo de información dentro de la app.
  • Para el flujo de trabajo utilizaremos Gitflow. Para el mismo deberan crear una rama con el numero de tarjeta con el que esten trabajando

image

  • Cuando el trabajo este terminado, se debe generar el "Pull Request" o PR como le solemos llamar. El proyecto ya cuenta con un template de PR, por lo que ustedes solo tendran que completar con los datos que les indica el template. Esta seria una imagen de ejemplo de un PR con su evidencia en caso de falla y su caso de éxito.

image

  • Las respuestas positivas se gestionan con el helper enpodintResponse, y los negativos con createHtppError de la libreria http-errors. Ejemplo de satisfactoria

Ejemplo de respuesta negativa: image

🚑 Helpers basicos

catchAsync

Es una función para estandarizar la forma en la que se crean los metodos en los controladores. Para ver mas buscar en helpers/catchAsync.js

endpointResponse

Estructura las respuestas positivas de toda la app. Dentro del archivo helpers/success.js podran ver que parametros le pueden pasar.

ErrorObject

Un objecto de error, el cual puede recibir varios atributos (pueden verlo en helpers/error.js) El mismo es una extensión de el objecto Error nativo de JS. Sirve para devolver errores cuando esten por fuera del controlador, y que los errores sean interceptados por el CATCH que tendran en los controllers.

grupo-n-9's People

Contributors

juanpbrizo avatar xamrof avatar cicarelligiuliano avatar sheice avatar lautarovollmer avatar adrianbturek avatar diegomedina62 avatar juanespinola05 avatar

Watchers

 avatar

Forkers

lautarovollmer

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.