https://github.com/open-eats/OpenEats
:pizza: Self Hosted Recipe Management App :hamburger:
https://github.com/open-eats/OpenEats
Last synced: about 1 month ago
JSON representation
:pizza: Self Hosted Recipe Management App :hamburger:
- Host: GitHub
- URL: https://github.com/open-eats/OpenEats
- Owner: open-eats
- License: mit
- Created: 2018-01-24T19:31:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-11T21:53:57.000Z (about 1 year ago)
- Last Synced: 2024-11-01T11:34:53.425Z (6 months ago)
- Language: Dockerfile
- Homepage: https://open-eats.github.io/
- Size: 92.8 KB
- Stars: 670
- Watchers: 19
- Forks: 102
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-starred - open-eats/OpenEats - :pizza: Self Hosted Recipe Management App :hamburger: (others)
README
# OpenEats Project
OpenEats is a recipe management site that allows users to create, share, and store their personal collection of recipes. This fork uses Django Rest Framework as a backend and React (with flux) as a front end.
The usage for the app is intended for a single user or a small group. For my personal use, I would be an admin user and a few (about 5-6) friends and family would be normal users. Admin users can add other users to the project (no open sign-ups), make changes to the available Cuisines and Courses, and add to the homepage banner. Normal users just have the ability to add recipes. Below are a few of the core features the app provides.
- Creating, viewing, sharing, and editing recipes.
- Update Serving information on the fly.
- Browsing and searching for recipes.
- Creating grocery lists.
- Automatically add recipes to your grocery lists.
- Quickly print recipe.
- Linking recipes and ingredient grouping.
### [Read the docs on getting started here!](docs/Running_the_App.md)
If you don't wish to use docker, see installation instructions here:
[Markdown](docs/Running_the_App_Without_Docker.md) OR [Media Wiki!](https://wiki.tothnet.hu/books/other/page/install-openeats-without-docker-and-run-on-apache2)
### [The Update guide can be found here!](docs/Updating_the_App.md)
# Demo
[](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/MrNuggelz/OpenEats/master/pwd-stack.yml)
# Contributing
Please read the [contribution guidelines](CONTRIBUTING.md) in order to make the contribution process easy and effective for everyone involved.
For a guide on how to setup an environment for development see [this guide](docs/Running_the_App_in_dev.md).