GigiAvila / AnimeApp-backend

Completed full-stack project: backend and frontend. Login with README user or create an account, verify via email token. Change personal info, avatar, email, or password. Simulated reading button; add logic for actual manga display. Manga auto-adds to history, preview on home page. Frontend: https://github.com/GigiAvila/AnimeApp-front.git

AnimeApp

Se trata de mi segundo proyecto en el 🌐 del backend. En este caso he trabajado con dos modelos de datos relacionados entre si (Mangas y Otakus) 🏯

Descripción

En este proyecto podrás hacer consultas, editar o eliminar elementos tanto del listado de mangas como de otakus (fanáticos del manga y la cultura pop japonesa). También podrás crear tus propios elementos para agregarlos a la base.

Requisitos previos

Para replicar este proyecto es necesario tener instalado Node.js y haber descargado y configurado MongoDB. A continuación deberías escribir el comando npm init -y en tu terminal y a continuación instalar las siguientes dependencias en tu package.json:

npm i express npm i mongoose npm i dotenv npm i cors npm i rate-limit npm i nodemailer npm i jsonwebtoken npm i bcrypt npm i multer npm i cloudinary npm i multer-storage-cloudinary

🔌¡No olvides configurar tus script en tu package.json! 🔌

 "main": "index.js",
  "scripts": {
    "start": "node .",
    "dev": "node --watch ."
  }

📎En este caso podrás encontrar un achivo "seed.js" donde encontrarás la base de datos para este ejercicio. Aquí puedes agregar nuevas propiedades o quitar algunas si lo deseas!

Uso

Una vez instalado y configurado todo deberás lanzar el comando npm run start para abrir el servidor en tu local y npm run dev para ejecutar el modo watch de Node y listo! 🙏Ya puedes iniciar tus peticiones.

En mi caso he utilizado la extensión "Thunder Client" en mi editor de código VS Code para poder simular las peticiones.

Rutas

Se han creado rutas que incluyen los métodos GET, POST, PUT y DELETE.

Las rutas disponibles en esta API con sus respectivos endpoints son:

👘 Endpoints para Otakus

1. GET /otakus: Obtiene una lista de todos los otakus de la base y además podrás ver la información básica del manga favorito que hayan declarado (su id y el nombre del manga)
2. GET /otakus/:id Obtiene un otaku en específico de la base a partir de su ID. En este endpoint también verás la información del ánime favorito del Otaku.
3. POST /otakus Crea un nuevo otaku.
4. DELETE /otakus/:id Borra un otaku de la base seleccionado por su ID.
5. PUT /otakus/:id: Edita cualquier campo de un otaku seleccionado por su ID. En este endpoint también podrás modificar el _favoriteManga que haya declarado y que se relaciona con el listado de Animes.

🏯 Endpoints para Animes

1. GET /mangas: Obtiene una lista de todos los animes de la base y además te mostrará los datos más relevantes de los Otakus relacionados (aquellos que lo hayan seleccionado como su manga favorito)
2. GET /mangas/:id Obtiene un manga en específico de la base a partir de su ID. En este endpoint podrás ver también los datos más relevantes del Otaku que haya declado a éste como su manga favorito.
3. POST /mangas Crea un nuevo manga.
4. DELETE /mangas/:id Borra un manga de la base seleccionado por su ID.
5. PUT /mangas/:id: Edita cualquier campo de un elemento manga seleccionado por su ID. En este caso también podrás modificar o agregar Otakus que sean _fans de este manga agregando su número de ID.

Ejemplos

Ejemplo de solicitud GET para pedir un Manga por ID :

Endpoint: http://localhost:4001/api/mangas/653828689d27095aead006cb

Ejemplo de una respuesta exitosa

  "data": {
    "_id": "65b1046e34aad2261667190f",
    "name": "One Piece",
    "author": "Eiichiro Oda",
    "format": [],
    "year": 1997,
    "principalCharacter": "Monkey D. Luffy",
    "isOngoing": true,
    "fans": [
      {
        "_id": "65b1047034aad22616671930",
        "name": "Li Wei",
        "surname": "Chen",
        "email": "[e-mail]"
      }
    ],
    "issues": 105,
    "cover": "https://res.cloudinary.com/dqdyvyknw/image/upload/v1700650307/onepiece_wwptje.jpg",
    "argument": "Follow the epic journey of Monkey D. Luffy as he sets out to become the Pirate King in a world of adventure, treasure, and powerful foes.",
    "__v": 0,
    "createdAt": "2024-01-24T12:37:02.761Z",
    "updatedAt": "2024-01-24T12:37:05.464Z"
  }
}

Ejemplo de solicitud PUT para editar los campos de un Manga por ID :

Endpoint: http://localhost:4001/api/mangas/653828689d27095aead006cb

Manga original

     {
      "_id": "65b1046e34aad22616671910",
      "name": "Naruto",
      "author": "Masashi Kishimoto",
      "format": [],
      "year": 1999,
      "principalCharacter": "Naruto Uzumaki",
      "isOngoing": false,
      "fans": [
        {
          "_id": "65b1047034aad2261667192e",
          "name": "Hannah",
          "surname": "Wilson",
          "email": "[e-mail]"
        },
        {
          "_id": "65b1047034aad22616671923",
          "name": "Luca",
          "surname": "Rossi",
          "email": "[e-mail]"
        },
        {
          "_id": "65b1047034aad22616671921",
          "name": "Maria",
          "surname": "Garcia",
          "email": "[e-mail]"
        },
        {
          "_id": "65b1047034aad2261667191f",
          "name": "John",
          "surname": "Doe",
          "email": "[e-mail]"
        }
      ],
      "issues": 70,
      "cover": "https://res.cloudinary.com/dqdyvyknw/image/upload/v1700650307/naruto1_dn7xld.jpg",
      "argument": "Join Naruto Uzumaki, a young ninja with dreams of becoming the strongest ninja and the leader of his village, as he embarks on a journey of self-discovery, friendship, and overcoming formidable foes.",
      "__v": 0,
      "createdAt": "2024-01-24T12:37:02.762Z",
      "updatedAt": "2024-01-24T12:37:05.464Z"
    },
}

Ejemplo de una respuesta exitosa