francoax / dsw-server

Poncho Home & Stay

Proyecto creado en la asignatura de Desarrollo de Software 2023.

• Poncho Home & Stay
  • Informacion general
  • Tecnologias
  • Metodologia
  • Documentacion
  • Guia de instalacion
  • Testing
  • Desarrolladores

Informacion general

PHS es una aplicacion de reservas, que da la posibilidad de reservar propiedades como tambien paquetes prearmados, que son el conjunto de una propiedad + auto + asistencia medica.

Link recorrido de la aplicacion: Video

Tecnologias

El proyecto se desarrollo utilizando el stack M.E.A.N.

• MongoDB
• Express
• Angular
• NodeJS

Por parte de estilos, se utiliza TailwindCSS a la par de DaisyUI, que ofrece una serie de componentes estilados con Tailwind. Ademas, para formateo de codigo, se utiliza ESLint.

Los tests corren con la dependencia de Jest.

Metodologia

Para las branches del proyecto, se sigue la forma:

• master: produccion
• dev: desarrollo

Para cada nueva implementacion, se utiliza la forma:

• feature/new-feature
• fix/problem

Ademas para no corromper los datos, existen dos bases de datos distintas. Una enfocada a produccion y otra a desarrollo, las cuales se pasan por variables de entorno en cada uno.

Ver MONGO_DB_URL en src/index.js

Para la publicacion del proyecto, ambas utilizan Vercel.

Documentacion

• Swagger: Luego de instalar el servidor, navegar a la ruta http://localhost:4000/api/api-docs
• Proposal: Proposal
• Trello: Trello
• Toda la conversacion/organizacion fue a traves de Discord

Guia de instalacion

El proyecto se desarrollo utilizando las siguientes versiones:

• AngularCLI 16.1.8
• NodeJS v18.17.0

Dicho servidor es la API del frontend. Pasos:

Clona el repositorio

git clone https://github.com/francoax/dsw-server

Navega a la carpeta del proyecto

cd .\dsw-server\

Instala las depedencias

npm install

Inicia la aplicacion

npm run start

Y listo, de esta manera ya el servidor estaria levantado. PHS puede realizar peticiones.

Testing

Los tests implementados cubren las entidades que se reconocieron como mas importantes. Estas son:

• Packages
• Properties
• Reserves
• Users

Cada test cubre todos los endpoints disponibles de cada entidad. Como explicacion, los tests corren con una base de datos de MongoDB en memoria, que se crea y destruye una vez finalizado los tests. Para esto, se crearon seeds de todas las entidades para cargar dicha base. De esta manera se evita que los test corrompan la base de datos original.

Para correr los test se debe de ejecutar:

npm run test

Desarrolladores

• 47308 Franco Duarte @francoax
• 46793 Octavio Pereyra @octapereyra
• 47502 Nicolas Di Dio @NicolasDiDio09
• 45757 Tomas Bottoni @tomasbottoni