sascha/OpenEats
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Self Hosted Recipe Management App
81 commits 1 branch 0 tags 248 KiB
Find a file
Exact
Sascha Wagner 3ed72b8e74 Remove version from yml for docker versions >= 26
2025-01-11 17:31:24 +01:00
docs Added remarks about startup and service files 2022-09-05 10:22:50 +02:00
releases adding path release 2019-03-13 16:39:19 -04:00
.gitignore Added automatic backups to Google Drive 2021-01-20 16:58:22 -06:00
_config.yml First Commit 2018-01-27 18:50:01 -05:00
backup.py Added automatic backups to Google Drive 2021-01-20 16:58:22 -06:00
commits.py Feature/script documentation (#28) 2018-03-30 12:08:32 +02:00
CONTRIBUTING.md updating docs 2018-01-28 23:31:03 -05:00
docker-compose.yml Docker changes to use local nginx and database 2022-07-10 17:03:56 +02:00
docker-prod.yml Remove version from yml for docker versions >= 26 2025-01-11 17:31:24 +01:00
docker-stage.yml Working prod on http://192.168.0.199:8000 2021-01-06 22:13:10 -06:00
env_dev.list Docker changes to use local nginx and database 2022-07-10 17:03:56 +02:00
env_stg.list Working prod on http://192.168.0.199:8000 2021-01-06 22:13:10 -06:00
LICENSE.md First Commit 2018-01-27 18:50:01 -05:00
MAINTAINERS.md updating docs 2018-01-28 23:31:03 -05:00
quick-start.py Docker changes to use local nginx and database 2022-07-10 17:03:56 +02:00
README.md Add reference to initial fork in README 2022-08-26 18:06:18 +02:00
release.py fixing release script import 2018-11-23 20:05:25 -05:00

README.md

OpenEats Project Fork

This fork incorporates changes to get OpenEats running on a Raspberry Pi 4. Here are the goals for this fork (from here):

Initial Goals

  • Run OpenEats on the Raspberry Pi
  • Add SSL and a firewall to secure the server
  • Develop a cron job for backing up the database to an external location. I've had bad luck with RPi SD cards failing.
  • Provide in-depth documentation of all these steps so others can do the same if desired

Docs

I kept all the original OpenEats docs in place, but will be adding on to the docs folder. Check out these docs I've written or updated:

Other Forks

Here are the other forks used with OpenEats

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!

If you don't wish to use docker, see installation instructions here: Markdown OR Media Wiki!

The Update guide can be found here!

Contributing

Please read the contribution guidelines 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.