Datawarehouse

Proyecto Datawarehouse

Aplicación web que permite gestionar información de contactos para campañas de marketing. Los usuarios de la plataforma pueden ver y editar el listado de contactos, compañías y ubicación (ciudad, pais, región). Sólo los usuarios administradores pueden crear usuarios nuevos.

Requisitos

Instalar mySQL

• Descargar mySQL

Instalar mySQL Workbench

• Descargar Nodejs

Instalar NodeJS

• Descargar Nodejs

Instalar Postman

• Descargar Postman

Despliegue

1) Clonar proyecto

• Clonar el repositorio desde github accediendo al link: datawarehouse
• Ó desde consola ejecutar:

git clone https://github.com/hernandba/datawarehouse

2) Instalar dependencias

npm install

3) Crear base de datos

• Abrir mySQL e iniciar los servicios del Server
• Abrir mySQL Workbench y crear una nueva MySQL Connection con información por defecto de localhost
• Generar la base de datos datawarehouse dentro del panel de control, ejecutar y/o importar el archivo que se encuentra en: /database/datawarehouseDB.sql

2) Modificar variables de entorno

• Abrir archivo .env en carpeta backend
• Modificar información de variables de acuerdo al entorno local:

DB_HOST='localhost'
DB_NAME='datawarehouse'
S_USER='root'
S_PASSWORD=''
DB_PORT='3306'

PORT=3000
ADMINKEY='d4^4{4r3h0u534dm1n'

5) Iniciar el servidor

node ./src/index.js

Documentación de la API

Endpoints:

URL: http://localhost:3000/

Métod	Endpoints	Descripción	Rol
POST	/login	Autenticación e inicio de sesión en el sistema	all
GET	/users	Obtiene información de todos los usuarios	all
POST	/users	Crear un nuevo usuario	admin
PUT	/users?{id}	Modifica la información de un usuario con su id	admin
PUT	/users?{id}	Elimina un usuario con su id	admin
GET	/locations	Obtiene información completa de todas las secciones (ciudad(es)/país(es)/región(es))	all
GET	/locations/:section	Obtiene toda la información de una sección especifica (regions, countries, cities)	all
GET	/locations/:section?{region_id}{country_id}	Obtiene información de una sección especifica (regions, countries, cities)	all
POST	/locations/:section	Crea una nueva entrada en la sección específica	all
PUT	/locations/:section/{id}	Modifica la información de una entrada específica con su id	all
DELETE	/locations/:section/{name}	Elimina una entrada especifica con su nombre	all
GET	/companies	Obtiene información de todas las empresas	all
POST	/companies	Crea una nueva empresa	all
PUT	/companies/{name}	Modifica la información de una empresa con su nombre	all
DELETE	/companies/{name}	Elimina una empresa con su nombre	all
GET	/contacts	Obtiene información de todos los contactos registrados	all
POST	/contacts	Crea un nuevo contacto	all
PUT	/contacts/{id}	Modifica la información de un contacto con su id	all
DELETE	/contacts/[ ids ]	Elimina uno o varios contactos con sus ids	all
GET	/contactsChannels?{contact_id}	Obtiene información de los canales de un contacto con su id	all
POST	/contactsChannels?{contact_id}	Crea un nuevo canal para un contacto con su id	all
PUT	/contactsChannels/{contact_channel_id}	Modifica la información de un canal especifico con su id	all
DELETE	/contactsChannels/{contact_channel_id}	Elimina un canal especifico con su id	all

Testing

• Backend: Testear endpoints con postman para usar API y base de datos
• Frontend: Abrir archivo index.html, iniciar sesión y continuar con navegación y operaciones

Recursos y tecnologías utilizadas

• NodeJS
• Postman
• MySQL Workbench
• NPM PACKAGES:
  • express
  • nodemon
  • jsonwebtoken
  • express-jwt
  • dotenv
  • mysql2
  • cors
  • compression
  • helmet

Autor

Hernán D Belalcázar A - Github hernandba.