Skip to content

pnellis/Foodiology

Repository files navigation

Foodiology

homepage

Video

Watch this video to learn more about the Foodiology project.

https://youtu.be/euVa12PUUjI?si=FBg18S_vWb4In3o0

Link to Website

Please only use safari to access our project!

This application is not optimized for mobile use.

https://foodiologyrecipes.com

Introduction

FoodiologyRecipes.com is a web application to provide users with a community to share and search for recipes. To be able to like, post, and comment on recipes, and save ingredients to the pantry you must create an account. However, all users (with or without an account) are able to search for recipes based on ingredients they input directly into the search bar.

Purpose

Foodiologyrecipes.com is great for individuals who have a variety of ingredients, but don’t know what to cook using them. Our website provides a platform for people to input their ingredients, select a preferred cuisine type, time needed to prepare, servings yield, and meal type (breakfast, lunch, dinner, beverage, dessert).

Key Features

  • Search Recipes: Search recipes based on ingredients you input, preferred cuisine type, time needed to prepare, servings yield, and meal type (breakfast, lunch, dinner, beverage, dessert).
  • Random Recipe of the Day: A random recipe of the day will be shown from the databse.
  • Create an Account: Create an account (email verification needed).
  • Edit Profile: Users with accounts can change their name, change their email, and update their passowrd.
  • Comment on Posts: Users with accounts and are logged in can comment on recipe posts.
  • Add Friends: Users can go to "Find Friends" and search for other users to view their recipes and add them as friends.
  • Pantry: Users with accounts can save ingredients to their pantry. After a user has saved their ingredients, they can go to "Search" and directly press search to find recipes using the ingredients in their pantry.

How to Run locally

To get started with our project on the local version, you must first create an environment to hold all relevant libraries and packages. To do this, open a terminal in the folder where you have cloned the repository type and the following:

  • cd Foodiology_FrontEnd
  • npm install axios
  • Python3 -m venv env
  • Install all packages listed in requirements.txt in Foodiology_BackEnd

To run the back-end:

  • cd Foodiology_BackEnd
  • python manage.py runserver

To run the front-end:

Open a second terminal (leave back-end running)

  • cd Foodiology_FrontEnd
  • npm run dev

See further documentation in the /doc subdirectory!

About

Welcome to the Foodiology repository. THIS LINK WILL ONLY WORK IN SAFARI!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors