From e0418bdcac93b1b0725ac3b085cdcc3215595876 Mon Sep 17 00:00:00 2001 From: zobkazi Date: Mon, 29 Apr 2024 20:31:45 +0600 Subject: [PATCH] readme file added --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d84cb8..e0c6d70 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,45 @@ -# PurrRescue-API +# User Pet Adoption and Rescue Platform +Welcome to the User Pet Adoption and Rescue Platform project repository! This platform aims to simplify the pet adoption process by connecting users with pets available for adoption. +## Project Overview + +The User Pet Adoption and Rescue Platform is developed using a microservices architecture, with several main services responsible for different functionalities: + +- Authentication Service (authUser) +- User Service (User) +- Adoption Service (Adoption) +- Notification Service (Notification) +- Reporting Service (Reporting) +- API Gateway (apiGateway) + +## Setup Instructions + +### Prerequisites + +- Docker +- Docker Compose +- RabbitMQ (optional if using RabbitMQ for asynchronous communication) + +### Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/zobkazi/PurrRescue.git + ``` + +2. Run the Docker Compose file: + + ```bash + cd PurrRescue + docker-compose up + ``` + +3. Access the Pet adoption and rescue platform at http://localhost:8081 + +4. Access the Pet adoption and rescue platform at http://localhost:8081 + +## Additional Resources + +- [User Pet Adoption and Rescue Platform](https://github.com/zobkazi/PurrRescue)