Backend App Sorteos

Backend de App de sorteos de Code Quest de Devtalles que incluye API REST de sorteos, autenticación y más.

---

Pasos y comandos para levantar backend:

Los pasos importantes para que nuestro backend funcione son agregar las variables de entorno, crear nuestra base de dato NoSQL local, poblar las colecciones de esta y correr el servidor local.

Configurar nuestras variables de entorno:

• Se debe crear el archivo .env y dentro de este pegar todas las variables de entorno del archivo .env.template.

Montar base de datos MongoDB:

docker-compose up -d

Poblar base de datos con datos de prueba:

npm run seed

Correr servidor local:

npm run dev

---

Tecnologías:

Para el desarrollo backend se usaron principalmente las siguientes tecnologías y enfoques:

• NodeJS: Entorno de ejecución para crear nuestro backend.
• Express: Framework de NodeJS.
• Typescript: Superset de Javascript para tipado estático.
• MongoDB: Base de datos NoSQL.
• Docker: Gestor de contenedores para montar base de datos de Mongo.
• Arquitectura limpia: Patrón de diseño de software para organizar el código en capas bien definidas.

---

Endpoints:

El endpoint base en nuestro servidor local es:

http://localhost:3000

Autenticación:

• Autenticar usuario:

  POST - /api/auth/login

  Request Body:

  {
    email: string,
    password: string
  }
  

---

Sorteo:

• Obtener todos los sorteos:

  GET - /api/raffle/

• Obtener último sorteo:

  GET - /api/raffle/latest

• Obtener un sorteo:

  GET - /api/raffle/{id}

  Parametros:

  • id (path): Id de sorteo a mostrar.

• Crear un sorteo:

  POST - /api/raffle/

  Request Body:

  {
    name: string,
    description: string,
    createAt: string,
    endAt: string,
    prize: string (mongoId),
  }
  

• Actualizar un sorteo:

  PUT - /api/raffle/{id}

  Request Body:

  {
   name: string,
   description: string,
   endAt: string,
   prize: string (mongoId),
  }
  

  Parametros:

  • id (path): Id de sorteo a actualizar.

• Eliminar un sorteo:

  DELETE - /api/raffle/{id}

  Parametros:

  • id (path): Id de sorteo a eliminar.

• Agregar usuario a un sorteo:

  POST - /api/raffle/users/{id}

  Parametros:

  • id (path): Id de sorteo en donde se agregará el partipante.

• Actualizar usuario a ganador en un sorteo:

  PUT - /api/raffle/winner/{id}/{userid}

  Parametros:

  • id (path): Id de sorteo a donde elegir un ganador.
  • userid (path): Id de usuario a actualizar como ganador.

---

Premio:

• Obtener todos los premios:

  GET - /api/prize/