_RESTful API implementando Clean Architecture _Este proyecto es una API desarrollada con Node.js y Express con el objetivo de ser utilizada de manera multipropósito, aprovechando su estructura y buenas prácticas.
Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas.
Que cosas necesitas para instalar el software y como instalarlas
Lo primero que necesitas hacer es crear un fork de este proyecto y clonarlo. Para comenzar a usar el software es necesario tener Node.js instalado en tu sistema y una instancia de base de datos Mongodb.
Una vez clonado el fork e instalado Node.js en tu sistema, podras instalar las dependencias del proyecto siguiendo estos pasos;
Instala las dependencias del proyecto
npm install
Agrega un archivo .env a la raiz del proyecto y pon tus credenciales
touch .env
PORT=<PORT>
MONGO_URI=<MONGO_URI>
APPLICATION_NAME=<APPLICATION_NAME>
JWT_SECRET=<JWT_SECRET>
CACHE_KEY=<CACHE_KEY>
SWAGGER_DOC=swaggerDEV
ZOOM_API_KEY=<ZOOM_API_KEY>
ZOOM_API_SECRET=<ZOOM_API_SECRET>
Ejecuta el proyecto
npm run dev
- Node - Entorno de ejecución
- Express - Framework Backend
- Mongoose - ORM
- Awilix - Inyección de dependencias
- Compression - Compresor de respuestas
- Helmet - Seguridad en cabeceras HTTP
- Morgan - Registro de solicitudes
- Jest - Testing
- Swagger - documentación
Usamos GitHub para el versionado. Para todas las versiones disponibles, mira los tags en este repositorio.
- Pablo Tedesco - Trabajo Inicial - tedesco8
También puedes mirar la lista de todos los contribuyentes quíenes han participado en este proyecto.
Este proyecto está bajo la Licencia (MIT) - mira el archivo LICENSE.md para detalles
- Comenta a otros sobre este proyecto 📢
- Invita una cerveza 🍺 o un café ☕ a alguien del equipo.
- Da las gracias públicamente 🤓.
- etc.
⌨️ con ❤️ por tedesco8 😊