Code Monkey home page Code Monkey logo

gachaapi's Introduction

Gacha API

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.

Requisitos Previos

  • 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.

Configuración

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:

  1. 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.

  2. 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 que MONGO_USER y MONGO_PASS son las credenciales de usuario para acceder a la base de datos.

  3. 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.

Uso

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.

Contribuyendo

Si deseas contribuir a este proyecto, sigue estos pasos:

  1. Haz un fork del repositorio.
  2. Crea una nueva rama (git checkout -b feature/nueva-funcionalidad).
  3. Haz tus cambios y realiza los commits (git commit -am 'Agrega nueva funcionalidad').
  4. Haz push a la rama (git push origin feature/nueva-funcionalidad).
  5. Crea un nuevo Pull Request.

Créditos

Este proyecto fue creado por Bruno.

gachaapi's People

Contributors

srzerorequiem avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.