Este proyecto implementa un sistema de "gacha" para recolección de personajes, donde los usuarios pueden realizar "rolls" para obtener personajes de diferentes rarezas y animes. Además, los usuarios pueden guardar, vender y administrar sus personajes en su colección.
- Node.js instalado en tu sistema.
- MongoDB instalado y ejecutándose en tu máquina o en un servicio de alojamiento como MongoDB Atlas.
- Clave de API de Discord si planeas usar la autenticación de Discord.
Antes de comenzar a utilizar la API, necesitarás configurar algunas variables de entorno para asegurarte de que la aplicación funcione correctamente. Aquí hay una lista de las variables de entorno necesarias y cómo configurarlas:
-
DISCORD_CLIENT_ID y DISCORD_CLIENT_SECRET: Estas variables se utilizan para la autenticación con Discord. Debes obtenerlas creando una aplicación en el Portal de Desarrolladores de Discord y obtener las credenciales de tu aplicación.
-
MONGO_URI, MONGO_USER y MONGO_PASS: Estas variables se utilizan para la conexión a tu base de datos MongoDB.
MONGO_URI
es la URI de conexión a tu base de datos, mientras queMONGO_USER
yMONGO_PASS
son las credenciales de usuario para acceder a la base de datos. -
JWT_SECRET: Esta variable se utiliza para firmar y verificar tokens JWT para la autenticación de usuarios. Debes configurarla con una cadena secreta aleatoria y segura.
Para configurar estas variables de entorno, puedes crear un archivo .env
en la raíz del proyecto y agregar las variables con sus valores correspondientes. Asegúrate de no incluir este archivo en tu repositorio git para mantener tus credenciales seguras.
Una vez que hayas configurado las variables de entorno, puedes iniciar el servidor y comenzar a utilizar la API. Puedes acceder a las diferentes rutas API para registrarte, iniciar sesión, realizar "rolls", guardar y vender personajes, entre otras funciones.
Para iniciar el servidor, puedes ejecutar el siguiente comando:
npm start
Asegúrate de consultar la documentación completa de la API para obtener más detalles sobre cómo utilizar cada ruta.
Si deseas contribuir a este proyecto, sigue estos pasos:
- Haz un fork del repositorio.
- Crea una nueva rama (
git checkout -b feature/nueva-funcionalidad
). - Haz tus cambios y realiza los commits (
git commit -am 'Agrega nueva funcionalidad'
). - Haz push a la rama (
git push origin feature/nueva-funcionalidad
). - Crea un nuevo Pull Request.
Este proyecto fue creado por Bruno.