API de Notificaciones Push

Description

Este proyecto es una aplicación del lado del servidor basada en Nest diseñada para gestionar usuarios, dispositivos y notificaciones. Incluye autenticación mediante JWT, gestión de usuarios, gestión de dispositivos y envío de notificaciones.

Configuración del proyecto

$ git clone <repository-url>

$ cd <project-directory>

$ cp .env.example .env

$ npm install

Compilar y ejecutar el proyecto

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Endpoints de la API

Autenticación

POST /auth/login

• Descripción: Iniciar sesión para obtener un JWT.
• Body:
  • username: Nombre de usuario.
  • password: Contraseña.

---

Usuarios

POST /users

• Descripción: Crear un nuevo usuario.
• Body:
  • username: Nombre de usuario.
  • password: Contraseña.
  • email: Correo electrónico.

GET /users/:id

• Descripción: Obtener un usuario por ID.
• Params:
  • id: ID del usuario.

GET /users

• Descripción: Obtener todos los usuarios.
• Respuesta: Lista de usuarios.

DELETE /users/:id

• Descripción: Eliminar un usuario por ID.
• Params:
  • id: ID del usuario.

---

Dispositivos

POST /devices

• Descripción: Crear un nuevo dispositivo.
• Body:
  • deviceId: ID del dispositivo.
  • userId: ID del usuario al que pertenece el dispositivo.
  • type: Tipo de dispositivo (por ejemplo, "android", "ios").
  • token: Token para enviar notificaciones push.

GET /devices/:id

• Descripción: Obtener un dispositivo por ID.
• Params:
  • id: ID del dispositivo.

GET /devices

• Descripción: Obtener todos los dispositivos.
• Respuesta: Lista de dispositivos.

DELETE /devices/:id

• Descripción: Eliminar un dispositivo por ID.
• Params:
  • id: ID del dispositivo.

---

Notificaciones

POST /notifications

• Descripción: Enviar una nueva notificación.
• Body:
  • message: Mensaje de la notificación.
  • deviceId: ID del dispositivo al que se enviará la notificación.

GET /notifications/:id

• Descripción: Obtener una notificación por ID.
• Params:
  • id: ID de la notificación.

GET /notifications

• Descripción: Obtener todas las notificaciones.
• Respuesta: Lista de notificaciones.

DELETE /notifications/:id

• Descripción: Eliminar una notificación por ID.
• Params:
  • id: ID de la notificación.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Mantente en contacto

• Autor - Ilan Angeles Rodriguez
• Sitio web - https://ilanangelesrodriguez.vercel.app

License

Nest is MIT licensed.