Skip to content

DevNavigator/DevNavigatorBackend

Repository files navigation

Logo de DevNavigator Backend

DevNavigator Backend 💻🖥️💙

Descripción del Proyecto 🤓

El backend de DevNavigator se encarga de gestionar la lógica del servidor, la base de datos y la autenticación de usuarios. Está diseñado para ser escalable y eficiente, proporcionando una API robusta para la interacción con el frontend.

Instalaciones Necesarias 🛠️

  • Node.js: https://nodejs.org/
  • PostgreSQL: https://www.postgresql.org/
  • NestJS CLI: npm install -g @nestjs/cli
  • Dependencias del proyecto:
    • npm install @nestjs/common @nestjs/core @nestjs/platform-express @nestjs/config @nestjs/jwt @nestjs/typeorm @nestjs/swagger @nestjs/schedule @nestjs/mapped-types
    • npm install bcrypt class-transformer class-validator cloudinary dotenv nodemailer pg reflect-metadata rxjs typeorm

Configuración del Proyecto ⚙️

  1. Clona el repositorio: git clone https://github.com/DevNavigator/DevNavigatorBackend.git
  2. Instala las dependencias: npm install
  3. Crea un archivo .env y configura tus variables de entorno.
  4. Inicia el servidor: npm run start

Funcionalidades del Backend 👾

  • Autenticación de usuarios mediante JWT
  • Gestión de usuarios y roles
  • Almacenamiento de datos en PostgreSQL
  • Documentación de la API con Swagger
  • Notificaciones en tiempo real

Integrantes del Equipo Backend de este proyecto 👥

Integrante Rol
Rivera López, Jorge Eduardo Backend
Di Donna Ramirez, John Alexander BackEnd
Martinez, Mauricio Backend

Documentación del Proyecto 📚

Este proyecto utiliza varias herramientas y bibliotecas para mejorar su funcionalidad. A continuación se detallan las implementaciones clave:

Swagger 📄

Swagger se utiliza para documentar la API de manera interactiva. Para acceder a la documentación, inicia el servidor y visita http://localhost:3001/api. Swagger proporciona una interfaz gráfica que te permite probar los endpoints de la API directamente.

Nodemailer ✉️

Nodemailer se utiliza para enviar correos electrónicos. La configuración se realiza a través de variables de entorno en el archivo .env. Puedes personalizar los correos electrónicos enviados a los usuarios, como la verificación de cuentas y notificaciones.

Cron Jobs ⏰

Los Cron Jobs se configuran utilizando el módulo @nestjs/schedule. Permiten ejecutar tareas programadas, como el envío de recordatorios o la limpieza de datos. La configuración se realiza en el módulo correspondiente, donde puedes definir la frecuencia y la tarea a ejecutar.

Cloudinary ☁️

Cloudinary se utiliza para la gestión y almacenamiento de imágenes. La configuración se realiza a través de las variables de entorno en el archivo .env. Puedes subir imágenes y obtener URLs para usarlas en la aplicación. Asegúrate de tener las credenciales correctas en tu archivo de configuración.

Para más información, consulta la documentación completa en el repositorio.

© 2024 DevNavigator. Todos los derechos reservados.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages