Coder Social home page Coder Social logo

cookbook's Introduction

Cookbook Application

Application is used to manage Recipes

Application is created using Java and Spring boot

Tests are created using Junit and Mockito

Application has following operations

  • Get a list of recipes (date created, description)
  • Add a new recipe
  • Add a new recipe based on another one - culinary fork of a recipe. Child recipes do not inherit anything from a parent recipe - they are just shown as children of a parent one. User can add child recipes to recipes on any depth.
  • Modify an existing recipe (on any depth).
  • Get all previous recipe versions (on any depth).
  • Recipes are sorted alphabetically (on any depth).

In order to use the application

  • Download the source code
  • Project is delivered as Maven project
  • Download and Install Maven
  • Open in your IDE
  • Once you opened the project in the IDE run - CookbookApplication and application will start.
  • unit tests for RecipeMapper and RecipeController included in the test directory.

As Frontend part is in progress - in order to use the application

  • Download and Install any API testing tool, e.g Postman

Endpoints description

  • http://localhost:8080/recipes - default endpoint.
  • / - Get all saved recipes sorted alphabetically
  • /save - Post a recipe and revert with ResponseDto.
  • /modify/{id} - Put a recipe. Modify existing recipe, if recipe not found - HttpStatus.NOT_FOUND status will be returned. If found - will be modified with supplied RequestDto, saved to DB and returned as a ResponseDto.
  • /fork/{id} - fork a recipe. If recipe is found by supplied id it will become a forked version of a found recipe. Recipe which is found by id becomes a parent of new recipe. if recipe not found - HttpStatus.NOT_FOUND status will be returned.
  • /versions/{id} - Get a List of all previous versions of a recipe. If no recipe found by supplied id HttpStatus.NOT_FOUND will be returned.
  • /delete/{id} - Finds and deletes a recipe by supplied id and returns a message Recipe deleted. If not found by id will return Recipe not found message.

cookbook's People

Contributors

likh-alex avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.