Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

451 Commits

Folders and files

Repository files navigation

HelloMeals

Status GitHub Issues GitHub Pull Requests License CI Pipeline


HelloMeals is a self-hostable recipe manager with an integrated scraper to scrape recipes in a large scale.

📝 Table of Contents

🧐 Features

WIP: Project is still in development and not feature complete!

  • Scrape and view Recipes from a central place
  • Scraper currently supports the following sites:
    • Chefkoch.de
    • Kitchenstories
    • Hellofresh
    • Lecker.de
    • Eatsmarter
    • Mobkitchen
  • Pantry Management
    • Add ingredients to your pantry
    • View which recipes you can cook with the current ingredients in your pantry
    • View recipes with a specific Ingredient
  • Manage & merge recipes tags for easier filtering
  • PWA for Mobile

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installing

A step by step series of examples that tell you how to get a development env running.

First clone this repository

git clone https://github.com/BastianLo/HelloMeals

Then install the required dependencies

pip install -r HelloMeals/requirements.txt

After successfully installing the dependencies, apply the django database migrations

HelloMeals/src/manage.py migrate

The Application is now correctly installed and can be run

python3 HelloMeals/src/manage.py runserver

🔧 Running the tests

WIP

🎈 Usage

WIP

🚀 Deployment

Docker

Fermento can easily be deployed using docker.

version: "3.3"
services:
    db:
        container_name: hello-meals-db
        image: postgres:15
        restart: always
        volumes:
            - ./postgres-data:/var/lib/postgresql/data
        environment:
            POSTGRES_USER: ${POSTGRES_USER}
            POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
            POSTGRES_DB: hellomeals
    hello-meals:
        container_name: hello-meals
        restart: always
        environment:
            - USERNAME=${USERNAME}
            - PASSWORD=${PASSWORD}
            - EMAIL=${EMAIL}
            - DEBUG=False
            - APP_URL=${APP_URL}
            - TIMEZONE=${TIMEZONE}
            - COUNTRY=${COUNTRY}
            - POSTGRES_HOST=db
            - POSTGRES_USER=${POSTGRES_USER}
            - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
            - DOWNLOAD_IMAGES=${DOWNLOAD_IMAGES} #Should images for recipes be downloaded? (True/False)
        ports:
            - "6753:6753"
        image: "bastianlo/hellomeals:latest"
        volumes:
            - ./data:/HelloMeals/src/data

⛏️ Built Using

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgements

This project is using icons from flaticon.com

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages