Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syedabdullahrahman/e-commerce

Simple E-commerce REST API
https://github.com/syedabdullahrahman/e-commerce

auditing e-commerce e-commerce-project ecommerce ecommerce-database liquibase logging mysql openapi openapi-specification slf4j spring-boot spring-data spring-data-jpa spring-data-rest swagger-ui

Last synced: 3 months ago
JSON representation

Simple E-commerce REST API

Host: GitHub
URL: https://github.com/syedabdullahrahman/e-commerce
Owner: syedabdullahrahman
License: mit
Created: 2024-06-26T17:37:00.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-07-05T12:49:26.000Z (7 months ago)
Last Synced: 2024-10-01T06:44:44.139Z (4 months ago)
Topics: auditing, e-commerce, e-commerce-project, ecommerce, ecommerce-database, liquibase, logging, mysql, openapi, openapi-specification, slf4j, spring-boot, spring-data, spring-data-jpa, spring-data-rest, swagger-ui
Language: Java
Homepage:
Size: 223 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Simple E-commerce REST API

[![Build and Test](https://github.com/syedabdullahrahman/e-commerce/actions/workflows/maven.yml/badge.svg)](https://github.com/syedabdullahrahman/e-commerce/actions/workflows/maven.yml)

# Table of Contents
- [Technologies Used](#technologies-used)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Database Schema](#database-schema)
- [Screenshots](#screenshots)

# Technologies Used

- Java 17
- Spring Boot 3.2.2
- Spring Data JPA
- Hibernate
- MySQL
- Maven
- Liquibase
- OpenAPI
- Docker
- Spring Data REST
- Test Containers
- Prometheus
- Grafana
- Tempo

# Features

- Retrieve a customer's wish list.
- Get the total sales amount for the current day.
- Determine the maximum sales day within a specified time range.
- Fetch the top N selling items of all time based on total sales amount.
- Get the top N selling items of the last month based on the number of sales.
- **Integration Testing**: Utilizes Test Containers for robust integration testing.
- **Observability**: Integrated with Prometheus, Grafana, and Tempo for monitoring and observability of the application.

# Getting Started

## Prerequisites

Ensure you have the following installed:

- **Java 17+**
- **Docker**

## Installation

Follow these steps to install and configure the project:

1. Clone the repository.
```bash
git clone https://github.com/syedabdullahrahman/e-commerce.git
```
2. Navigate to the project directory.

3. Build the project using Maven.
```bash
mvn clean install
```
4. Run the application
```bash
java -jar target/demo-0.0.1-SNAPSHOT.jar
```

### OR

**Run the application using Docker Compose:**
```bash
docker-compose up
```

# Screenshots

- *OpenAPI or Swagger UI for testing API*

![Screenshot 1](screenshots/swagger-ui.PNG)

- *Application HTTP requests metrics*

![Screenshot 2](screenshots/grafana-ecommerce-app-stat.PNG)

- *Application overall metrics*

![Screenshot 3](screenshots/grafana-spring-boot-stat.PNG)

### Database Schema
The database schema is from [MySQL Sample Database](https://www.mysqltutorial.org/getting-started-with-mysql/mysql-sample-database/)

Here is the schema diagram:

![schema](mysql-sample-database.png)