ToadVault-MVP_microservices es una caja registradora web basada en microservicios, desarrollada en Nest.js y conectada a través de Redis. Utiliza una arquitectura de microservicios para gestionar diferentes aspectos del negocio, como usuarios, productos, inventario, órdenes y pagos.
Puedes acceder a la aplicación en producción a través del siguiente enlace:
¡Disfruta usando ToadVault-MVP_microservices!
- Framework Backend: Nest.js
- Base de Datos: MongoDB
- Message Broker: Redis
- Contenedorización: Docker
- Gestión de Dependencias: Docker Compose
- Documentación de API: Swagger
Antes de ejecutar la aplicación, asegúrate de tener Docker y Docker Compose instalados en tu sistema.
- Puedes instalar Docker siguiendo las instrucciones en Get Docker.
- Para instalar Docker Compose, sigue las instrucciones en Install Docker Compose.
- Abre el archivo
docker-compose.ymlen un editor de texto. - Dentro de cada servicio, encuentra la sección
environment, donde se definen las variables de entorno. - Configura los valores de las variables de entorno según tus necesidades, por ejemplo, los nombres de usuario y contraseñas de MongoDB, las claves de JWT, etc.
- Guarda los cambios en el archivo
docker-compose.yml. - Abre una terminal y navega hasta el directorio que contiene el archivo
docker-compose.yml. - Ejecuta el siguiente comando para construir y levantar los servicios de la aplicación:
docker-compose up --build -d- Una vez que todos los servicios estén en funcionamiento, podrás acceder a la aplicación a través del puerto 3000.
¡Y eso es todo! Ahora tu aplicación ToadVault-MVP_microservices estará en funcionamiento y lista para su uso.
La documentación de la API está disponible a través de Swagger. Puedes acceder a ella una vez que la aplicación esté en funcionamiento visitando la siguiente URL en tu navegador:
Una vez allí, podrás explorar los diferentes endpoints, ver los esquemas de datos y probar las solicitudes directamente desde el navegador. La documentación de Swagger proporciona una visión completa de la API y facilita su comprensión y uso.
El microservicio de Usuarios gestiona la información relacionada con los usuarios registrados en la aplicación. Proporciona eventos para la creación y recuperación de datos de usuario.
El microservicio de Productos gestiona el catálogo de productos disponibles. Funciona como una base de datos global que será utilizada por todos los usuarios para guardar cualquier producto y su código de barras (barcode). Este microservicio actúa como un repositorio centralizado para todos los productos y sus códigos de barras.
Cualquier nuevo código de barras será agregado automáticamente a esta base de datos. Si un usuario intenta agregar un producto a su inventario y este no existe en la base de datos, el microservicio lo añadirá y luego se lo agregará al inventario del usuario en cuestión. De esta manera, se garantiza que todos los usuarios tengan acceso a un catálogo completo y actualizado de productos.
El microservicio de Inventario controla el stock de productos disponibles en la tienda. Proporciona eventos para gestionar la cantidad de productos disponibles y para realizar ajustes de inventario.
El microservicio de Orden gestiona las órdenes realizadas por los usuarios. Funciona como un generador de órdenes única para transacciones de punto de venta.
El microservicio de Pago se encarga del procesamiento de los pagos asociados a las órdenes realizadas por los usuarios. Su función principal es recibir las solicitudes de pago, procesar los pagos y devolver el cambio correspondiente al cliente.
El microservicio de API Gateway actúa como punto de entrada principal para la aplicación. Enruta las solicitudes de los clientes a los microservicios correspondientes y gestiona la comunicación entre los diferentes componentes de la aplicación.
MongoDB es un sistema de base de datos NoSQL orientado a documentos. En esta aplicación, se utiliza para almacenar datos relacionados con usuarios, productos, inventario, órdenes y otros aspectos del negocio.
Redis es una base de datos en memoria de código abierto que se utiliza como almacén de datos en esta aplicación. Se utiliza para gestionar la mensajería y la comunicación entre los diferentes microservicios de la aplicación