Recipeasy

Recipeasy is an app to crowdsource human-guided parsing/structurisation of recipe data.

The process is as follows:

1. An ETL step downloads recipe articles from the Content API, makes a best-effort pass to extract individual recipes and parse them, and writes them to a PostgreSQL DB.

2. You will then need to call an end point that migrates New recipes (the outcome of the previous point) into Ready status. (See section "Running ETL locally").

3. A Play app selects semi-parsed recipes from the DB, displays them to users and guides them through the process of parsing/verifying them.

Running ETL locally

First create and set up the PostgreSQL DB using the init-dev-DB.sh script. This will:

• Install PostgreSQL (using Homebrew) if necessary
• Start the PostgreSQL server if it is not already running
• Create the necessary DB schema and users
• Run any necessary DB migrations using the Flyway sbt plugin

Once you have a DB, you can run the ETL script:

$ sbt "etl/run <capi key>"

... where <capi key> refers to your developer personal CAPI key. If you do not already have a CAPI key, please apply for one at https://bonobo.capi.gutools.co.uk/register/developer. Note that when creating a CAPI key through Bonobo, you will get a key of the developer tier. This is fine for running the ETL script, but the image table won't be updated. To get the image table updated you will need to upgrade your key to the internal tier. Ask a member of the team to do this for you if you do not have access to Bonobo admin.

The ETL script should run for a few minutes. By the end, you will have a few thousand recipes in your DB.

The next step is then to call the /admin/prepare-recipes end point which migrates recipes in New status into Ready. Note that you need have the play app running to do this. (See "Running play app")

curl -X POST http://localhost:9000/admin/prepare-recipes

Upgrading the Database

If you want to upgrade the database, you need to write the corresponding migration file in recipeasy/common/src/main/resources/db/migration (and should respect the naming conventions) and then run

./flyway-mutation-dev-DB.sh

For a production update run (from your local machine)

./flyway-mutation-prod-DB.sh [RDS-INSTANCE-DNS-NAME(without port)]

and then provide the production database password when asked for it. (Ask for a member of the team where to find the password).

Running play app

Ensure that Postgres is running

postgres -D /usr/local/var/postgres &

Start the play application

$ sbt "ui/run"

The user interface is then available at http://localhost:9000/recipe/curate.

And if you haven't done so already, run

curl -X POST http://localhost:9000/admin/prepare-recipes