Skip to content

Latest commit

 

History

History
143 lines (86 loc) · 4.48 KB

Readme.md

File metadata and controls

143 lines (86 loc) · 4.48 KB
Raw

Product Catalog Management API

Overview

This project is an API for a product catalog management system in a marketplace application. The API allows users to manage products and categories, associate products with categories, and maintain their product catalog. The system is designed to handle multiple requests per second and ensure that the product catalog remains up-to-date and accessible.

Technologies Used

  • Node.js: Backend runtime environment
  • Express.js: Web framework for Node.js
  • PostgreSQL: Database for storing product and category data
  • RabbitMQ: Service for catalog change notifications
  • MinIO: Storage for catalog JSON files
  • Docker: Containerization platform

Constraints

  • A product can only be associated with one category at a time.
  • Products and categories belong to only one owner.
  • The catalog should handle multiple requests per second for editing items/categories and accessing the catalog search endpoint.

Catalog Management

  • The product catalog is considered a JSON compilation of all available categories and items owned by a user.
  • Changes to the product catalog are published to the "catalog-emit" queue in RabbitMQ.
  • A consumer listens to catalog changes for a specific owner and updates the catalog JSON in a MinIO bucket.

Setup Instructions

Docker Setup

  1. Clone the repository:

    git clone https://github.com/MSpilari/SQSApi.git

  2. Create a .env file in the root directory and add the following:

    POSTGRES_USER_TEST="<Choose whatever you want>"

POSTGRES_PASSWORD_TEST="<Choose whatever you want>"

POSTGRES_DB_TEST="<Choose whatever you want>"

POSTGRES_USER_PROD="<Choose whatever you want>"

POSTGRES_PASSWORD_PROD="<Choose whatever you want>"

POSTGRES_DB_PROD="<Choose whatever you want>"

RABBITMQ_DEFAULT_USER="<Choose whatever you want>"

RABBITMQ_DEFAULT_PASS="<Choose whatever you want>"

RABBITMQ_URL="amqp://RABBITMQ_DEFAULT_USER:RABBITMQ_DEFAULT_PASS@rabbitmq:5672/" 

MINIO_PORT="9000"

MINIO_ACCESS_KEY="<Choose whatever you want>"

MINIO_SECRET_KEY="<Choose whatever you want>"

    2.1 Create a .env.development file in the root directory and add the following:

    DATABASE_URL="postgresql://POSTGRES_USER_TEST:POSTGRES_PASSWORD_TEST@localhost:3335/POSTGRES_DB_TEST?schema=public"

PORT=""

POSTGRES_USER_TEST=""

POSTGRES_PASSWORD_TEST=""

POSTGRES_DB_TEST=""

JWT_SECRET=""

REFRESH_SECRET=""

RABBITMQ_URL="amqp://RABBITMQ_DEFAULT_USER:RABBITMQ_DEFAULT_PASS@localhost:5672/"

MINIO_ENDPOINT="localhost" 

MINIO_PORT="9000"

MINIO_ACCESS_KEY=""

MINIO_SECRET_KEY=""

    2.2 Create a .env.prod file in the root directory and add the following:

    DATABASE_URL="postgresql://POSTGRES_USER_PROD:POSTGRES_PASSWORD_PROD@db_prod:5432/POSTGRES_DB_PROD?schema=public"

PORT=""

POSTGRES_USER_PROD=""

POSTGRES_PASSWORD_PROD=""

POSTGRES_DB_PROD=""

JWT_SECRET=""

REFRESH_SECRET=""

RABBITMQ_URL="amqp://RABBITMQ_DEFAULT_USER:RABBITMQ_DEFAULT_PASS@rabbitmq:5672/"

MINIO_ENDPOINT="minio" 

MINIO_PORT="9000"

MINIO_ACCESS_KEY=""

MINIO_SECRET_KEY=""

  3. Run the application using Docker Compose:

    docker-compose up -d

Documentation

The Api docs is served from swagger at localhost:3333/api-docs or localhost:6666/api-docs

RabbitMQ Integration

  • Producer: Used for publishing catalog change notifications.
  • Consumer: Listens to the "catalog-emit" queue. On receiving a message, it fetches the owner's catalog from the database, generates the catalog JSON, and uploads it to the specified MinIO bucket.

MinIO Integration

  • Bucket: Used for storing the catalog JSON files.

Consumer for Catalog Changes

  • Listens to the "catalog-emit" queue in RabbitMQ.
  • On receiving a message, fetches the owner's catalog from the database.
  • Generates the catalog JSON and uploads it to the specified MinIO bucket.

Conclusion

This API provides a robust system for managing a product catalog in a marketplace application, ensuring efficient handling of multiple requests and seamless integration with RabbitMQ and MinIO for catalog updates and storage. Running the application via Docker ensures a consistent and easily deployable environment.