Skip to content

Latest commit

 

History

History
101 lines (77 loc) · 3.68 KB

README.md

File metadata and controls

101 lines (77 loc) · 3.68 KB
Raw

Recipe Sharing Platform Backend Coding Challenge

Introduction

Your task is to build the backend functionality for a Recipe Sharing Platform. The platform allows users to create, share, and search for recipes. Users can create an account, log in, and perform various operations such as creating, updating, and deleting recipes, as well as searching for recipes based on different criteria.

Requirements

User Authentication

  1. Implement user registration with email, username, and password.
  2. Ensure password hashing and storage for security purposes.

Recipe Management

  1. Implement CRUD (Create, Read, Update, Delete) operations for recipes.
  2. A recipe should have the following attributes:
    • Title (required)
    • Username (required)
    • Description (optional)
    • Ingredients (required, comma-separated values)
    • Instructions (required)
    • Servings (optional)
  3. Ensure that the ingredients use the metric system.
  4. Provide an endpoint to retrieve a list of recipes created by a specific user.
  5. All recipe management endpoints require authentication.

Ingredients

When looking at the ingredients, we see a 1:n relationship between the recipe and ingredients. Therefore, it's recommended to manage ingredients in a second table with at least four columns:

  • recipe_id
  • value
  • unit
  • type

Useful Units

unit comment
g Gram
kg Kilogram
ml Milliliter
l Liter
pc Piece
tsp Teaspoon
tbsp Tablespoon
pinch A dash

Examples

value unit type
8 pcs egg
.05 l milk
1 dash salt

Recipe Search

  1. Implement a search functionality that allows users to search for recipes based on the following criteria:
    • Username (exact match or partial match)
    • Title (exact match or partial match)
  2. Return a list of matching recipes based on the search criteria.
  3. All recipe search endpoints require authentication.

Optional: Recipe Recommendations

  1. Implement a "recommendations" functionality that recommends recipes based on the current weather forecast.
  2. The recommendations work as follows:
    1. Avoid recipes that require baking if the outside temperature is above x degrees Celsius.
    2. Avoid recipes using frozen ingredients if the outside temperature is below x degrees Celsius.

Implementation

  • Use Java or Kotlin and the Spring Boot Framework for the implementation.
  • Use a database of your choice to store the user and recipe information.
  • Pay attention to error handling and validation of incoming data.

API Documentation

Include clear and concise documentation for all endpoints, including request/response examples and any additional information required to understand and use the API.

Testing

Write unit tests for the implemented functionality to ensure proper operation and behavior.

Submission

  • Provide a GitHub repository containing your code.
  • Include a SETUP.md file with instructions on how to set up and run your application.
  • Optionally, you can deploy your application to a hosting service and provide a link to the live demo.

Evaluation Criteria

  • Implementation of all the required features and functionalities.
  • Code structure, readability, and maintainability.
  • Proper usage of HTTP status codes and RESTful principles.
  • Error handling and validation of incoming data.
  • Test coverage and quality of unit tests.
  • Documentation clarity and completeness.

Note

  • Focus on implementing the backend functionality only. No need to spend time on frontend/UI development for this challenge.
  • Read the ABOUT.md for more details about this source code.