lukpacho/product-catalog repository overview

⁠Product Catalog Microservice

This Docker image provides a microservice for managing a product catalog. It allows retrieving all products and fetching a single product by its ID.

⁠Usage

To run a container from this image, use the following command:

docker run -p 3001:3001 product-catalog-microservice

The microservice will be accessible at http://localhost:3001.

⁠API Endpoints

• GET /api/products: Retrieves all products.
• GET /api/products/:id: Retrieves a single product by its ID.

⁠Environment Variables

This microservice does not require any environment variables to be set.

⁠Volumes

This microservice does not use any volumes.

⁠Docker Network

To enable communication between the Product Catalog microservice and other microservices or applications, ensure that the containers are connected to the same Docker network. You can achieve this by following these steps:

1. Create a Docker network:

   docker network create my-network
   

   Copy

2. Run the Product Catalog microservice container with the --network flag:

   docker run --network my-network -p 3001:3001 product-catalog-microservice
   

   Copy

3. Run other microservice or application containers on the same network:

   docker run --network my-network -p 4000:4000 ecommerce-ui
   

   Copy

By connecting the containers to the same Docker network, they can communicate with each other using their container names as hostnames.

⁠Building the Image

If you want to build the Docker image yourself, follow these steps:

1. Clone the repository containing the application code.
2. Navigate to the directory where the Dockerfile is located.
3. Run the following command to build the image:

   docker build -t product-catalog-microservice .
   

   Copy
   This command will build the Docker image using the provided Dockerfile and tag it as product-catalog-microservice.

⁠Contributing

If you would like to contribute to this project, please follow the guidelines in the CONTRIBUTING.md⁠ file.

⁠License

This project is licensed under the MIT License⁠.

⁠Support

If you encounter any issues or have questions regarding this Docker image or the Product Catalog microservice, please open an issue⁠ on the GitHub repository.