Skip to content

cs0320-f23/term-project-mding16-rchae2-jlum3-acodjoe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

ChefBear

ChefBear is a "duolingo for cooking" that aims to promote diversity in the cooking realm and increase exposure to diverse foods that are not always easily accessible for anyone from novice chefs, home cooks, to anyone curious about demystifying cultural recipes.

Created by: Ariana Codjoe, Jeremy Lum, Michelle Ding, Rachel Chae

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

When you run ChefBear, you will see the login page. Here, you can choose to log in using your Google Account. We will only store a unique user ID to allow us to store your level progress.

Login page

Once you have logged in, you have the option to choose between four different regions. DISCLAIMER: In this beta version of ChefBear, we picked regions that aligned with the countries provided in the meal database we drew from (TheMealDB). These regions are not representative of all the existing countries and cuisines in the world. We hope to expand our coverage in future versions.

Regions page

Once you have selected a region, you will be brought to the levels page where you see all the possible levels you can unlock in the region. The screenshot below shows a user currently at level 3. DISCLAIMER: recipes in ChefBear are sorted into "levels" by a difficulty score based on number of ingredients and number of instructions. We recognize that this is not a realistic representation of how cultures determine recipe difficutly. In the future, we hope to develop a more nuanced definition of difficulty.

Levels page

Once you select a level, you get 3 recipes generated for you to pick from. This part is up to you! Choose your favorite and get cooking. Once you are done, click the "completed" button to move on to the next level.

Recipes page

This is what your levels page will look like once you have completed a level. Level 4 has unlocked! Happy Cooking!

Updated levels page

Built With

React, Bootstrap, Firebase

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • start application and run tests
    npm run start
    npx playwright test
  • npm
    npm install
  • react-router-dom
    npm install react-router-dom
  • react-slick
    npm install react-slick
    npm install --save @types/react-slick
    npm install slick-carousel --save
  • firebase
    npm install firebase
  • bootstrap
    npm install bootstrap
    npm install --save aos@next

Installation

Clone the repo

git clone https://github.com/cs0320-f23/term-project-mding16-rchae2-jlum3-acodjoe.git

(back to top)

CITATIONS & ACKNOWLEDGEMENTS

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published