OnlyHack API es un backend desarrollado con Node.js, Express y MongoDB para proporcionar funcionalidades relacionadas con la gestión de datos para la plataforma OnlyHack.
- Clona este repositorio:
git clone https://github.com/tuusuario/onlyhack-api.git - Instala las dependencias:
npm install - Configura las variables de entorno creando un archivo
.enven el directorio raíz del proyecto y proporciona los valores necesarios (ver .env.example).
- Para ejecutar en modo de desarrollo:
npm run dev - Para ejecutar en modo de producción:
npm start
- POST /auth/register: Registra un nuevo usuario.
- POST /auth/login: Inicia sesión y genera un token de autenticación.
- Describe aquí las principales funcionalidades de tu API y los endpoints correspondientes.
El archivo de configuración .env contiene las siguientes variables:
PORT: Puerto en el que se ejecutará el servidor.MONGODB_URI: URI de conexión a la base de datos MongoDB.JWT_SECRET: Clave secreta para firmar tokens JWT.
- bcrypt: Para el hashing de contraseñas.
- cors: Middleware para habilitar el CORS.
- dotenv: Para cargar variables de entorno desde un archivo
.env. - express: Marco de aplicación web para Node.js.
- http-errors: Creación de errores HTTP para Express.
- http-status-codes: Lista de códigos de estado HTTP.
- jsonwebtoken: Generación y verificación de tokens JWT.
- mongoose: Librería de modelado de objetos MongoDB.
- morgan: Middleware para el registro de solicitudes HTTP.
Las contribuciones son bienvenidas. Si deseas contribuir a este proyecto, por favor abre un issue para discutir los cambios propuestos.
Este proyecto está bajo la licencia ISC. Para más detalles, consulta el archivo LICENSE.
