/Proyecto-Delilah

Delilah-Resto

Primary LanguageJavaScript

Delilah Resto Backend 🍔 🍟

⭐ Proyecto Bloque 3 - DWFS de Acámica. ⭐

El proyecto consiste en la creación de un sistema de pedidos online para un restaurante, en este caso llamado Delilah Restó. Se debe poner en funcionamiento las partes necesarias para montar una REST API que permita realizar altas, bajas, modificaciones y obtención de información sobre una estructura de datos que podría consumir un cliente.

Recursos y tecnologías utilizadas

  • 📌 Node.js: funcionalidades centrales del lado del servidor.
  • 📌 XAMPP: funcionalidad del lado del servidor MySQL.
  • 📌 MySQL: base de datos relacional.
  • 📌 JWT: autenticación via Token.
  • 📌 Postman: manejo de endpoints y testing.
  • 📌 Swagger: documentación de API.
  • 📌 Express
  • 📌 Sequelize
  • 📌 Nodemon

Caracteristicas

  • 📌 Inicio de sesión de usuario con JWT
  • 📌 Validación de roles
  • 📌 CRUD Usarios
  • 📌 CRUD Productos
  • 📌 CRUD Ordenes

Documentación de la API

En el siguiente link de swagger, se podrá visualizar todos los endpoints y documentación necesaria para delilah resto.

DOCUMENTACION SWAGGER

Pasos de instalación e inicialización

1 - Instalar Node

Se va a necesitar nodejs. Puedes comprobar si ya lo tienes instalado en tu sistema mediante el comando

node -v

En el caso de no tenerlo instalado, descargar e instalar NODE.

2 - Clonar proyecto e instalación de dependencias

git clone https://github.com/egarzon85/Proyecto-Delilah.git

cd proyecto-delilah

npm install

3 - Creación e inicializacion base de datos

  • Descargar e Instalar XAMPP.
  • Ejecutar XAMPP e inicializar los servicios Apache y MySQL.
  • Abrir el panel de control MySQL. http://localhost/phpmyadmin/
  • Dentro del panel de control, importar el archivo /db/delilahresto.sql

Nota: en la base de datos se encuentran pre-cargados 2 usuarios, 3 productos, 3 medios de pago y 5 status de ordenes.

  • Usuario regular
    User: john, Password: regular

  • Usuario admin
    User: maria, Password: admin

  • Payment Methods
    1-efectivo, 2-credito, 3-debito

  • Status
    1-nuevo, 2-confirmado, 3-preparando, 4-enviando, 5-entregado

4 - Iniciando el servidor

Desde la terminal ejecute el siguiente comando:

nodemon index

Si todo fue realizado correctamente, debe poder visualizar la siguiente leyenda:

El servidor express corre en el puerto 3000 Conectado

De esta manera ya tenemos nuestro servidor en ejecución y listo para usar.

5 - Test API 🚀

  • Descargar e instalar la aplicación Postman.

  • En la ruta /documentation/DelilahResto.postman_collection.json se provee una colección funcional de endpoints con ejemplos para poder hacer uso de la API, la cual solamente se debe proceder a importar en Postman.