Adopting Microservices Architecture in Node.js Projects

{
  "title": "Adopting Microservices Architecture in Node.js Projects",
  "description": "Guidelines for designing and implementing microservices architecture in Node.js applications to improve scalability and maintainability.",
  "category": "Node.js Cursor Rules",
  "rules": [
    {
      "id": "nodejs-microservices-modular-design",
      "description": "Structure your Node.js application into modular microservices, each responsible for a specific business capability, to enhance maintainability and scalability.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Refactor your application into independent microservices aligned with distinct business domains."
    },
    {
      "id": "nodejs-microservices-api-gateway",
      "description": "Implement an API Gateway to manage and route requests to your microservices, handling cross-cutting concerns like authentication and rate limiting.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Integrate an API Gateway to centralize request management and enhance security."
    },
    {
      "id": "nodejs-microservices-async-communication",
      "description": "Utilize asynchronous communication between microservices using message brokers to decouple services and improve resilience.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Implement a message broker like RabbitMQ or Kafka for asynchronous inter-service communication."
    },
    {
      "id": "nodejs-microservices-containerization",
      "description": "Containerize each microservice using Docker to ensure consistency across development, testing, and production environments.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Use Docker to containerize your microservices for consistent deployment and scaling."
    },
    {
      "id": "nodejs-microservices-monitoring",
      "description": "Implement centralized monitoring and logging to track the health and performance of your microservices.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Set up monitoring tools like Prometheus and Grafana to observe microservice metrics and logs."
    },
    {
      "id": "nodejs-microservices-security",
      "description": "Ensure secure communication between microservices by implementing authentication and authorization mechanisms.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Use OAuth 2.0 or JWT for secure inter-service communication and access control."
    },
    {
      "id": "nodejs-microservices-fault-tolerance",
      "description": "Implement fault tolerance mechanisms such as circuit breakers to handle service failures gracefully.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Use libraries like 'opossum' to implement circuit breakers and prevent cascading failures."
    },
    {
      "id": "nodejs-microservices-ci-cd",
      "description": "Establish Continuous Integration and Continuous Deployment pipelines to automate testing and deployment of microservices.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Set up CI/CD pipelines using tools like Jenkins or GitLab CI to streamline microservice deployment."
    },
    {
      "id": "nodejs-microservices-database-per-service",
      "description": "Assign each microservice its own database to ensure loose coupling and independent scaling.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Design each microservice with its own database to maintain autonomy and scalability."
    },
    {
      "id": "nodejs-microservices-caching",
      "description": "Implement caching strategies to reduce latency and improve performance of microservices.",
      "severity": "warning",
      "pattern": ".*",
      "recommendation": "Use caching solutions like Redis to store frequently accessed data and reduce database load."
    }
  ]
}