README.md

Base Api Express - Sequelize

Este proyecto basado en express, como indica el titulo ser una base para realizar una api de servicios REST con el ORM Sequelize.

Comenzando 🚀

Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas.

Estructura de proyecto

├── api.js
├── app.js
├── config
|  ├── ambiente.js
|  ├── config.js
|  └── globales.js
├── controllers
|  └── prueba.js
├── database
|  ├── bd.json
|  └── sequelize.js
├── LICENSE.md
├── models
├── package-lock.json
├── package.json
├── README.md
└── routes
   ├── main.js
   └── prueba.js

Instalación 🔧

npm install

Post-Instalación ⚙️

Modificar los parametros de la base de datos antes de iniciar.
Ruta: database/bd.json

Dialect El dialecto definido para esta base es: postgres.
Para cambiar el dialecto: aquí

{
  "dev": {
    "username": "username",
    "password": "password",
    "database": "database",
    "host": "host",
    "dialect": "postgres",
    "port": "port",
    "define": {
      "timestamps": false
    },
    "schema": "schema"
  },
  "qa": {
    "username": "username",
    "password": "password",
    "database": "database",
    "host": "host",
    "dialect": "postgres",
    "port": "port",
    "define": {
      "timestamps": false
    },
    "schema": "schema"
  },
  "production": {
    "username": "username",
    "password": "password",
    "database": "database",
    "host": "host",
    "dialect": "postgres",
    "port": "port",
    "define": {
      "timestamps": false
    },
    "schema": "schema"
  }
}

sequelize-auto permite mappear las tablas de la base de datos y generar los modelos de forma automatica.

npm i -g pg@6.4.2
npm i -g sequelize-auto
Ejemplo: sequelize-auto -o "./models" -d database -h host -u user -p port -x pass -e dialect -s schema

Development 📦

Inicia el servidor con Nodemon

npm run dev

Producción ⌨️

npm start

Construido con 🛠️

• body-parser - middleware para analizar cuerpos de solicitud HTTP
• cors - Control de acceso HTTP
• express - Framework WEB
• express-list-endpoints - Permite mapear los puntos de acceso de los servicios REST
• morgan - Logger REST
• node-color-log - Logger con colores
• sequelize - ORM
• sequelize-auto - Permite mapear las tablas de la base de datos
• pg - Cliente Postgres
• pg-hstore - Serializando y Deserializando JSON de consultas Postgres
• helmet - Seguridad API.

Autor ✒️

• Sergio Andrés Orellana Roa - Edhine - Ingeniero De Desarrollo - Linkedin - Github

Licencia 📄

Este proyecto está bajo la Licencia MIT - mira el archivo LICENSE.md para detalles.

Pendientes 📌

• Mocha - Paquete para Test sobre la API.
• Log con archivo.

Retroalimentación

Todo comentario y correcciones, no dudes en mencionarlas 📢, me ayudas a mejorar este proyecto ❤.

Expresiones de Gratitud 🎁

• Comenta a otros sobre este proyecto 📢
• Da las gracias públicamente 🤓.
• etc.

---

⌨️ con ❤️ por Edhine 😊