Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fedorovychh committed Feb 29, 2024
1 parent 196d30c commit cdb6c87
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit cdb6c87

Please sign in to comment.