Algafood API Spring RESTful

food delivery API
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Reference Documentation
• Guides

About The Project

This project will serve as the basic architecture for implementing any spring project with the best practices and technologies.

Built With

• Java 11
• Spring Boot
• Spring Data JPA
• Spring Cloud Feign
• Papertrail
• Prometheus
• Grafana
• Zipkin
• MongoDB
• Swagger
• Mapper Struct
• Amazon SNS
• Docker
• Gradle
• Intellij - IDE

Getting Started

To run the project it is important to meet the requirements by installing the following dependencies.

Prometheus

http://localhost:9090/

Zipkin

http://localhost:9411/

Grafana

http://localhost:3000/

PAPERTRAIL

http://localhost:3000/

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

1. Clone the repository

git clone https://github.com/leonardofaria00/algafood-api.git

Usage

Run: http://localhost:8080/swagger-ui.html

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Leonardo F. Santos - more info - leonardofaria00@gmail.com

Reference Documentation

For further reference, please consider the following sections:

• Spring Web
• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image

Guides

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring