From cdb6c87af6ce507f9b68e3ba6f85556db0d735a6 Mon Sep 17 00:00:00 2001
From: Valerii Fedorovych <valera.fedorovich.2000@gmail.com>
Date: Thu, 29 Feb 2024 15:49:43 +0200
Subject: [PATCH] added readme

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3028865
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# Seller Retail Reports API
+
+This Spring Boot project helps in managing of Amazon seller reports. It can work with a big amount of data and different fields of statistics.
+
+
+
+## Demo
+
+[Watch video of working API --- YouTube Link](https://www.youtube.com/embed/7ooeL1PQU1Q?si=OUybXtMFl6JrWSrU)
+
+![Swagger UI API demonstration](images/swagger-ui.jpg)
+
+
+## Tech Stack
+
+Technologies that used to create an efficient and well-organized environment for the development and management of the Reports API.
+
+**Java 17**
+
+**Spring Boot**
+
+**Spring Security**
+
+**Spring Cache**
+
+**Spring Data MongoDB**
+
+**MongoDB**
+
+**API Documentation:** Swagger
+
+**Build Tool:** Maven
+
+
+
+## Run Locally
+
+**This API requires JDK 17 and MongoDB Compass**
+
+Clone the project
+
+```
+git clone https://github.com/fedorovychh/seller-retail-reports.git
+```
+
+Open project in Inteliji IDEA
+
+Load Maven dependencies
+
+Define properties in application.properties file to match your need
+
+Open address http://localhost:8081/swagger-ui/index.html in your browser
+
+Success!!! You can start the project.