RootXL Microservice is a powerful NestJS-based microservice designed for the RootXL platform. It integrates MongoDB, RabbitMQ, and Redis to provide a robust and scalable backend solution. This service is built to handle complex workflows and data management needs efficiently.
The RootXL Microservice employs a microservice architecture that leverages:
- MongoDB: A flexible and scalable database for primary data storage.
- RabbitMQ: Implements robust message queuing for asynchronous communication between microservices, ensuring reliable task management.
- Redis: Provides efficient caching for frequently accessed data, improving response times and reducing load on the database.
Ensure you are using MongoDB v7 or above for compatibility.
The MongoDB setup is included as a Git submodule. Please initialize and update the submodule before running the service.
Ensure the following Node.js and npm versions are installed:
"engines": {
"node": ">=20.6.1",
"npm": ">=8.0.0"
}
Follow these steps to get the service running for local development:
- Install dependencies:
npm install
- Build the project and verify there are no errors:
npm run build
- Start the service locally:
npm start
Ensure you have MongoDB, RabbitMQ, and Redis running and properly configured before starting the service. Configuration details can be set in the .env
file.
If you have any questions or need assistance, feel free to reach out to the development team or refer to the documentation for detailed guidance.