Skip to content

Latest commit

 

History

History
111 lines (81 loc) · 4.44 KB

README.md

File metadata and controls

111 lines (81 loc) · 4.44 KB

KitchenOwl

Stars License Docker pulls

KitchenOwl

A grocery list and recipe manager

KitchenOwl is a self-hosted grocery list and recipe manager. The backend is made with Flask and the frontend with Flutter. Easily add items to your shopping list before you go shopping. You can also create recipes and add items based on what you want to cook.

🍫 🥘 🍽

✨ Features

The following features have been implemented:

  • Add items to your shopping list and sync them with multiple users
  • Partial offline support, so you don't lose track of what to buy even when there is no signal
  • Manage recipes and add them to your shopping list
  • Create a meal plan to know what you'll be eating
  • Mobile/Web/Desktop apps

This project is still in development, so some features may not be fully implemented yet.

For a list of planned features, check out the Roadmap!

📱 Screenshots

Updates page

Details page

Search page

🤖 App Install

Get it on Google Play or find the current release for your operating system on the releases page.

🗄️ Server Install

You can either install only the backend or add the web-app to it. Docker is required.

Backend only

Using docker cli:

docker volume create kitchenowl_data
docker run -d -p 5000:5000 --name=kitchenowl --restart=unless-stopped -v kitchenowl_data:/data tombursch/kitchenowl:latest

Backend and Web-app

Recommended using docker-compose:

  1. Download the docker-compose.yml
  2. Change default values such as JWT_SECRET_KEY and the URLs (corresponding to the ones your instance will be running on)
  3. Run docker-compose up -d

🙌 Contributing

From opening a bug report to creating a pull request: every contribution is appreciated and welcomed. If you're planning to implement a new feature or change the API please create an issue first. This way, we can ensure your work is not in vain. For more information see Contributing

📚 Related

🔨 Built With

📜 License

KitchenOwl is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the Apache-2.0 License.