https://github.com/yildizmy/recipe-app

Spring Boot app used for managing data of favorite recipes
https://github.com/yildizmy/recipe-app

docker docker-compose dockerfile filtering flyway food hibernate ingredient java jpa postgresql recipe rest-api spring-boot spring-data-jpa spring-mvc

Last synced: 10 days ago
JSON representation

Spring Boot app used for managing data of favorite recipes

• Host: GitHub
• URL: https://github.com/yildizmy/recipe-app
• Owner: yildizmy
• License: mit
• Created: 2023-01-03T17:35:12.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T09:41:46.000Z (4 months ago)
• Last Synced: 2024-07-15T11:38:12.486Z (4 months ago)
• Topics: docker, docker-compose, dockerfile, filtering, flyway, food, hibernate, ingredient, java, jpa, postgresql, recipe, rest-api, spring-boot, spring-data-jpa, spring-mvc
• Language: Java
• Homepage:
• Size: 488 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Recipe API

Project used for managing data of favourite recipes.

### Description

The application allows users to manage their favourite recipes. It also allows users adding, updating, removing and fetching recipes. 

Additionally, users can filter available recipes based on one or more of the following criteria:

1. Whether the dish is vegetarian

2. The number of servings

3. Specific ingredients (either include or exclude)

4. Text search within the instructions

### Architecture

The information about the project structure and architectural choices are given on [Architecture](src/main/resources/docs/architecture.md) section.

### Getting Started

In order to run and test the application, see details on [How to run?](src/main/resources/docs/how_to_run.md) and [How to test?](src/main/resources/docs/how_to_test.md) sections.

For API documentation of the application, please visit the following pages: 


[Swagger](http://localhost:8080/swagger-ui/index.html)


[Javadoc](src/main/resources/javadoc/index.html)

### Dependencies

* Spring Boot

* Spring Web

* Spring Data JPA

* Project Lombok

* JUnit

* SpringFox

* Flyway

* PostgreSQL

### Documentation

[Spring Boot Reference Documentation](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/)


[Spring Data JPA Reference Documentation](https://docs.spring.io/spring-data/jpa/docs/current/reference/html/)


[JUnit 5 User Guide](https://junit.org/junit5/docs/snapshot/user-guide/)


### Version History

* 0.1 Initial Release