sw20-tug/asd-morning-7

The repo for the team ASD: Morning 7

COOK

Personal cookbook
Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
• Usage
• Roadmap
• Contributing
• License
• Acknowledgements

About The Project

COOK is a single-user application for managing personal cooking recipes.

Built With

Based on modern web technologies and frameworks, COOK is built using:

• Spring Boot
• React

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Java 13

Usage

• For starting COOK, switch to the server directory and use the command below:

  ./mvnw spring-boot:run

• To run all unit tests, issue the following command:

  ./mvnw test

For more examples, please refer to the Documentation.

Roadmap

See the GitHub Project for a list of features which are currently in development.

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/COOK_<issue_ID>

3. Commit your changes:

   git commit -m 'COOK-<issue_id> <short_description> <list_of_author_initials>'
   # Example (author: John Doe): git commit -m 'COOK-003C Implement certain functionality [DJ]'

4. Push to the feature branch:

   git push origin feature/COOK_<issue_ID>

5. Open a pull request

License

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

Acknowledgements

• README template

asd-morning-7's Issues

COOK_004 Rename recipes

As a user I want to be able to edit or rename existing recipes.

Acceptance criteria:

• It should be possible to rename an existing recipe
• Renaming means changing the title of the recipe
• This should be possible directly from the overview without going to another screen

COOK_000 Setup project

Create a new project (e.g. Android Studio project), add setup instructions to README and submit any additional supporting files (e.g. gitignore).

COOK_003 Option to rename, edit and delete recipes

As a user I want to be able to rename, edit or delete existing recipes. Therefore I want to click on one of the recipes and get these three options.

Acceptance criteria:

• When long clicking (or right clicking) on a recipe or pressing on the edit icon next to the recipe an action selection (or a context menu) should appear
• It should be possible to rename the recipe (COOK_004)
• It should be possible to delete the existing recipe (COOK_005)
• It should be possible to edit the recipe (COOK_09)

COOK_010 Step-by-step guides

As a user I want to add step-by-step cooking instructions to each recipe. I also want to be able to delete, add new or change existing ones.

Acceptance criteria:

• Each recipes should have editable step-by-step guides
• The mode can be disabled for each recipe, so that this recipe doesn’t have the option to insert step-by-step guides and thus have no option to start the onsite-cook mode (COOK_012)
• New steps can be added (description plus photo)
• Existing steps can be edited
• Existing steps can be deleted
• Existing steps can be reordered

COOK_002B Add new recipes: Back end

In order to support the creation of new recipes, a Step model must be created and the RecipeController must be adjusted to implement the required functionality.

COOK_007 Overview search

As a user I want to search through all my recipes to easily find dishes to cook.

Acceptance criteria:

• A search option should be provided
• Related to COOK_001: it should be possible to search all recipes regarding to their properties

COOK_005B Delete recipes: Back end

COOK_000A Setup project: React

COOK_002D Add new recipe: Back end Testing

COOK_004A Rename recipes: Front end

COOK_0005 User Authentication

COOK_001B Recipe overview: Back end

COOK_001 Recipe overview

As a user I want to see all of my saved recipes when starting the application. An option to select between favorites and all will help finding favorite recipes easier.

Acceptance criteria:

• All recipes are displayed directly after opening the application:
  • A picture should support the name, the preparation and cooking time and type of the recipe
  • It should consist of two tabs “All” and “Favorites”
  • User can browse all recipes

COOK_001D Recipe overview: Back end Testing

Setup of Testing Structure Included. Please see this guide for testing SpringBoot applications.

COOK_002C Add new recipe: Front end Testing

Setup of Testing Structure included!

COOK_002 Add new recipes

As a user I want to be able to add new recipes to my existing collection. Therefore I want to add all information and/or pictures to my new recipe before it gets inserted into the list.

Acceptance criteria:

• A button at the overview should be available to add a new recipe
• A screen to insert a new recipe should appear
• All recipes must at least have the following required data:
  • Name of the dish
  • Description
  • What kind of meal is it? (Fish, chicken, pork, vegan,...)
  • Preparation time
  • Cooking time
  • Cooking instructions
  • Photo(s) (one or more)
• Confirm or cancel should be provided

COOK_012 Add CI for npm

Add CI for the front end tests.

COOK_000B Setup project: DBMS

COOK_000C Setup project: Spring Boot

Initialize the back end application (Spring Boot). To do so, the following guide can be used.

COOK_009B Edit recipe: Back end

COOK_013 Bundle client and server applications

As a user, I want to be able to execute the COOK application using a single command.

Acceptance criteria:

• When executing ./mvnw spring-boot:run, the front and back end application should be started

COOK_011 Start onsite-cooking mode

As a user I want to use the step by step guide directly while cooking. It should show all necessary steps to do and also gets supported with pictures while “playing” the recipe.

Acceptance criteria:

• This mode can be started from the detail view (only for those recipes having a step-by-step guide)
• By clicking on start each step will be shown in fixed order
• One option to continue to next step or cancel onsite-cooking mode

COOK_005A Delete recipes: Front end

COOK_004B Rename recipes: Back end

COOK_014 Bug: Sorting steps in the back end

The steps have to be sorted on the back end

COOK_005 Delete recipes

As a user I want to be able to delete existing recipes.

Acceptance criteria:

• It should be possible to delete an existing recipe
• Before deleting an recipe to user has to confirm (yes/no) this deletion

COOK_001C Recipe overview: Controller

COOK_008 Detail view

As a user I want to see all detailed information about my recipes, by just clicking on one of them.

Acceptance criteria:

• When clicking on a recipe a new screen should appear
• This should show all further information
• A “play” or “zoom icon” like button should be provided in the overview to open this screen

COOK_001B Recipe overview: Database schema

A uniform database schema must be created which can be used by the front-end and back-end teams.

The schema should incorporate all properties of a recipe mentioned within the acceptance criteria of #2.

COOK_009 Edit recipe

As a user I want to be able to edit and maintain all of my recipe data.

Acceptance criteria:

• All details should be editable by the user

COOK_001A Recipe overview: Front end

Part A of #1.

As a user I want to see all of my saved recipes when starting the application. An option to select between favorites and all will help finding favorite recipes easier.

Acceptance criteria:

• All recipes are displayed directly after opening the application:
• A picture should support the name, the preparation and cooking time and type of the recipe
• It should consist of two tabs “All” and “Favorites”
• User can browse all recipes

COOK_002A Add new recipes: Front end

Dynamic form to create a new recipe and its respective steps. For acceptance criteria have a look at #2.

COOK_006 Overview filtering

As a user I want to filter all my recipes regarding their information about what kind of, preparation time, cooking time, etc. for an easier search.

Acceptance criteria:

• A filtering option should be provided
• Related to COOK_001: it should be possible to filter all recipes regarding to their properties

COOK_009A Edit recipe: Front end