Mihir1003 / open-recipes

Open source recipe planner

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project Proposal for Fall 2023

Lucas Pierce


Contributors

Back end - csc365 Molly Sandler - mosandle@calpoly.edu Alfred Madere - amadere@calpoly.edu Mihir Chintawar- mchintaw@calpoly.edu

Front end - csc307 Alfred Madere Pau Minguet Abigayle Mercer Kassi Winter Michael Murray


Project Description

We propose to develop a service for a meal planning and recipe management aimed primarily at college students and young adults. The service will allow users to manually enter recipes into their personal "cookbook" or add existing recipes from a public library. A "week planner" feature will enable users to plan meals for the week, generating a shopping list based on the selected recipes. Additional features like recipe rating, picture uploads, and recipe forking are planned. The service aims to solve the problem of meal planning and grocery shopping, making it easier and more efficient for people first living on their own. While the MVP will focus on core functionalities, future iterations could include AI-enabled inventory management and a premium feature set.


Technical Specifications

Backend Requirements

  • Public API: The API will be publicly accessible, adhering to the project's open-source nature.
  • Persistence Layer: A relational database will be used for data storage.
  • Read and Write Operations: The API will support CRUD operations for recipes, shopping lists, and user profiles.

Features for MVP

  1. User Authentication: Secure login and registration.
  2. Personal Recipe Lists: CRUD operations for recipes, lists and ingredients.
  3. Public Recipe Library: Read-only access to a collection of public recipes.
  4. Week Planner: Ability to add recipes to a plan and generate shopping list from that.
  5. Recipe Rating and Reviews: Users can rate recipes and write revivews

Future Features

  • AI-enabled "Fridge" feature for inventory management.
  • Average prep time and cost of ingredients.
  • Recipe scaling based on the number of people.
  • Premium features for paying customers.

hello from new branch

About

Open source recipe planner


Languages

Language:Python 87.2%Language:TypeScript 12.1%Language:Dockerfile 0.4%Language:JavaScript 0.3%