Skip to content
Roel Villaluz edited this page Jul 22, 2024 · 1 revision

Welcome to the Foodhub Wiki

This wiki contains all the documentation you need to get started with the Foodhub Recipe Website.

Table of Contents

Introduction

Foodhub is a dynamic recipe website built with Django, allowing users to create, view, and manage recipes. The site features user authentication, recipe CRUD functionality, and dynamic filtering and searching capabilities.

Installation

Prerequisites

  • Python 3.x
  • Django 3.x

Steps

  1. Clone the repository:
    git clone https://github.com/RoelVillaluz/Foodhub.git
    cd Foodhub
  2. Create and activate a virtual environment:
    python -m venv env
    source env/bin/activate  # On Windows, use `env\Scripts\activate`
  3. Install the dependencies:
    pip install -r requirements.txt
  4. Run the database migrations:
    python manage.py migrate
  5. Start the development server:
    python manage.py runserver

Usage

  1. Open your web browser and go to http://127.0.0.1:8000/.
  2. Explore the available recipes, or add your own by creating an account.

Features

  • User authentication and profile management
  • CRUD functionality for recipes and reviews
  • Dynamic filtering and searching for recipes
  • User preferences including allergens
  • Recipe recommender based on preferences such as:
    • Cuisine
    • Budget
    • Cook time
    • Allergens
  • Search Recipes by ingredient
  • Adding ingredients to a shopping list for future use
Clone this wiki locally