alejandrojosue / shortlinks-backend

backend for create shorter links

shortLink - Backend for Shorter Links

shortLink es un proyecto de backend diseñado para gestionar una API de acortador de enlaces. Esta aplicación utiliza buenas prácticas de desarrollo, se conecta a MongoDB para el almacenamiento de datos, integra documentación Swagger para una fácil comprensión de la API, utiliza ESLint con la configuración Standard para mantener un código limpio y consistente, y emplea el sistema de testing propio de Node.js.

Características Principales

• Gestión de Enlaces:

  • Permite la creación, recuperación y gestión de enlaces acortados de manera eficiente.

• Conexión a MongoDB:

  • Utiliza MongoDB como base de datos para un almacenamiento seguro y escalable de enlaces.

• Documentación Swagger:

  • La API está documentada automáticamente mediante Swagger, proporcionando una referencia clara y accesible para los desarrolladores.

• ESLint con Standard:

  • Implementa ESLint con la configuración Standard para mantener un código consistente y de alta calidad.

• Testing Integrado:

  • Incluye un conjunto de pruebas propias de Node.js para garantizar la integridad del código y el correcto funcionamiento de la aplicación.

Instalación

1. Clona el repositorio: git clone https://github.com/tu-usuario/shortLink.git

2. Instala las dependencias npm install

Instalación

1. Inicia la aplicación: npm install

2. Accede a la documentación Swagger en http://localhost:3000/api/docs para explorar la API.

Estructura del Proyecto

• app: Contiene el código principal de la aplicación.
• test: Incluye las pruebas unitarias de la aplicación.
• config: Configuraciones de la aplicación.
• docs: Documentación swagger adicional.

Licencia

Este proyecto está bajo la Licencia ISC. Consulta el archivo LICENSE para más detalles.

Autor

Alejandro Díaz