Delivery-API

Status: Developing ⚠️

Contents

• What is it?
• Requirements
• Technologies Used
• Installation
• Diagrams

What is it?

• Delivery-Api is a RESTFul-API developed in Java, Spring Boot and MySQL. This API is designed to manage a back-end application for managing a food delivery enterprise.

Requirements

• Java 12+
• Spring Boot
• MySQL 8.0+
• Lombok

Technologies Used

• Java
• Spring Boot (version 2.2.2.RELEASE)
• Spring Data JPA
• Spring Hateoas
• Spring Security
• Spring Swagger
• MySQL
• Flyway
• Docker
• Lombok
• Model Mapper
• Squiggly Filter
• JasperReports
• Data Transfer Object (DTO)

Installation

Git Clone

• To install the api by Git clone, follow the instructions available at https://github.com/Fa2bio/Delivery-Api/tree/main/Utils/Local;

Docker

• To install the api by Docker, follow the instructions available at https://github.com/Fa2bio/Delivery-Api/tree/main/Utils/Docker;

Diagrams

• To access a copy of the database, import in your MySQL Workbench the Delivery_SQL_Diagram.mwb file available at Delivery_SQL_Diagram.zip

Class Diagram

SQL Diagram