Skip to content

MateoGurrea02/Delilah-Resto

Repository files navigation

Delilah Restó

Este proyectyo consta de la construccion de una rest API para una app de pedidos de un restaurante

Comenzando 🚀

Lo primero que debes hacer para montar el servidor en tu computadora es abrir el proyecto con Visual Studio Code

Pre-requisitos 📋

  • Uno de los requisitos para poder levantar el servidor es instalar NodeJs y NPM en tu computadora, Para eso podes seguir esta pequeña guia
https://www.cursosgis.com/como-instalar-node-js-y-npm-en-4-pasos/

O podes entrar a la pagina oficial de NodeJs descargar el instalador correspondiente a tu sistema operativo y version y seguir los pasos que te indica

https://nodejs.org/es/download/
  • Lo siguiente que tenemos que instalar es MariaDB en la computadora para que podamos interpretar las instrucciones de la base de datos, para eso podes seguir esta pequeña guia
https://techexpert.tips/es/windows-es/instalacion-de-mariadb-en-windows/

O tambien podes entrar a la pagina oficial de MariaDB y seguir las instrucciones

https://mariadb.com/downloads/#mariadb_platform-mariadb_server
  • Y por ultimo tenemos que intalar DBeaver para ejecutar las intrucciones y datos de la bsae de datos, aunque se pueden instalar otros administradores de bases de datos si lo desean

Para instalar DBeaver podes seguir esta pequeña guia

https://luissoto.website/como-instalar-y-configurar-dbeaver-en-windows-10/

O podes entrar a la pagina oficial de DBeaver y seguir los pasos para su instalacion

https://dbeaver.io/download/

Instalación 🔧

Ahora si con Node y Npm instalados tenes que abrir el proyecto con Visual Studio Code, y en la terminal que trae integrada el editor de codigo, deberas correr el siguiente comando, para instalar todas las dependencias y librerias que va a utilizar el proyecto

npm i

una vez intaladas las dependencias deberas abrir DBeaver y crear la base de datos como se muestra a continuacion

La contraseña correspondiente a la base puede ser cualquiera pero por defecto te recomiendo que pongas root

Lo siquiente es abrir un script para ingresar los datos y tablas de la base de datos

para crear la base de datos deberas copiar todo el codigo que esta en el archivo data_bases.sql y pegarlo en el script que abriste y por ultimo ejecutarlo

Podes ejecuralo de dos manera

  • Desde el simbolo indicado en la img siguiente
  • O colocando el mouse en cada una de las lineas y apretar ctrl+enter de manera secuencial,(Tabla por tabla) de arriba hacia abajo

Iniciando el servidor 💻

Si dejaste la configuracion por defecto de la DB puedes saltarte esto

antes de poner arriba nuestro servidor tenes quie ir al archivo .env y corroborar los datos que hay en el si no son los correspondientes a los que tienes en tu base de datos deberas cambiarlos para que funcione

Todo listo

una vez que corremos el script de la base de datos en DBeaver tenemos que ir a nuestro editor de codigo y ejecutar el siguiente comando el la terminal

npm run dev

Y listo nuestro servidor ya esta arriba

Documentacion📖

Con el servidor ya levantado para poder ver la documentacion del proyecto, desde el navegador tenemos que pegar la siguiente url

http://localhost:3000/api-docs

Mas Ejemplos de los endpoint en postman

https://www.postman.com/blue-star-799371/workspace/delilha-resto/overview

About

API REST de Delilah Restó

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published