EFZR / REST-API-Node-TS-Server-admin_productos

🚀 REST API Node.js TypeScript Server

¡Bienvenido! Este es un proyecto de un servidor REST API construido con Node.js y TypeScript. 🛠️ Utilizamos una base de datos PostgreSQL para almacenar los datos de los productos. 📦

Para manipular la base de datos, utilizamos el ORM Sequelize. 🗃️

Este proyecto se creó con el objetivo de entender cómo crear un servidor en Node.js usando la tecnología de Express.js y comprender los fundamentos de un servidor REST API. 🎯

Esperamos que este proyecto te sea útil y te ayude a aprender más sobre la creación de servidores REST API con Node.js y TypeScript. ¡Disfrútalo!

🛠️ Tecnologías Utilizadas

Este proyecto utiliza una variedad de tecnologías modernas para garantizar un desarrollo rápido y eficiente:

• Express.js: Framework web rápido, flexible y minimalista para Node.js.
• TypeScript: Superset de JavaScript que agrega tipado estático a la sintaxis de JavaScript.
• Sequelize: ORM basado en promesas para Node.js.
• PostgreSQL: Sistema de gestión de bases de datos relacional de código abierto.
• Colors: Librería para darle color a la consola de Node.js.
• Dotenv: Módulo que carga variables de entorno desde un archivo .env.
• Nodemon: Herramienta que ayuda a desarrollar aplicaciones basadas en Node.js al reiniciar automáticamente la aplicación cuando se detectan cambios en el directorio.
• jest: Framework de pruebas de JavaScript.
• supertest: Módulo de pruebas de extremo a extremo para Node.js.
• swagger: Herramienta de documentación de API.

Instalación y ejecución 📦

Para instalar y ejecutar este proyecto, sigue los siguientes pasos:

1. Clona el repositorio: git clone https://github.com/EFZR/REST-API-Node-TS-Server-admin_productos.git
2. Navega al directorio del proyecto: cd REST-API-Node-TS-Server-admin_productos
3. Instala las dependencias: npm install
4. Configure Environment Variables
   • Locate the file named .env.example in the project root.
   • Rename this file to .env.
   • Open the .env file and replace the placeholder values with your actual data. Each variable represents a piece of configuration that your application needs to run correctly.
5. Ejecuta el proyecto: npm run dev

Ahora, la aplicación debería estar corriendo en http://localhost:3000.