The official Web UI for OpenEats
Find a file
2022-10-09 15:58:29 +02:00
config fixing tests 2018-12-31 18:08:55 +01:00
modules Make prep and cook time optional (and prevent issues with reading 0 from the db and updating) 2022-10-09 15:58:29 +02:00
public Replaced icons 2022-07-10 18:53:53 +02:00
scripts Feature/build cleanup (#7) 2018-03-27 20:57:04 +02:00
.gitignore Feature/build cleanup (#7) 2018-03-27 20:57:04 +02:00
.travis.yml Feature/build cleanup (#7) 2018-03-27 20:57:04 +02:00
CONTRIBUTING.md updating contributing guide default branch to master 2018-01-28 23:02:56 -05:00
Dockerfile web running on rpi 2021-01-06 22:19:12 -06:00
LICENSE.md First Commit 2018-01-27 18:56:32 -05:00
package.json Add sortablity to the Grocery List (#44) 2020-07-04 21:20:28 +02:00
README.md Updated README 2022-08-26 17:36:09 +02:00
test.yml Feature/build cleanup (#7) 2018-03-27 20:57:04 +02:00
tests.sh Feature/build cleanup (#7) 2018-03-27 20:57:04 +02:00
yarn.lock Add sortablity to the Grocery List (#44) 2020-07-04 21:20:28 +02:00

Purpose of this Fork

This fork is setup to run on a Raspberry Pi 4 and contains a few other updates. See the main OpenEats repository for more information.

Modifications to this Repo

  • Updated Dockerfile to run on RPi
  • Allow Recipe source to not be a URL. This allows you to use the name of a physical cookbook instead
  • Replaced default recipe icons for more variations
  • Removed random recipe suggestions from the recipe view

OpenEats Web App

Web Build Status Coverage Status Maintainability

This is the official web app that powers OpenEats. It's built using React/Redux.

See the homepage for more information about OpenEats!

Contributing

Please read the contribution guidelines in order to make the contribution process easy and effective for everyone involved.

Dev Tips

Running tests

To run tests locally:

cd openeats-api
docker-compose -f test.yml -p test build
docker-compose -f test.yml -p test run --rm --entrypoint sh web
./node_modules/.bin/jest --coverage

Generating locale files

After adding new defineMessages you'll need to update the locale files. Instead of doing it manually you can run this script to do it for you.

docker-compose run --rm web sh
./node_modules/.bin/babel-node scripts/merge-locale.js

Building the demo site

The demo site is built using pure js and relies on populating the redux store when the app starts. If more data needs to be added be sure to update the demo json

To Build the demo site, update the dev env file with the below.

# Node config
NODE_ENV=demo
NODE_API_URL=
NODE_LOCALE=en

Then Run:

docker-compose up node

This will generate all the require files in the public folder. These files can be copied directly into the demo repo.