https://github.com/pearofducks/foodprocessor

A react/mobx javascript app for displaying recipes
https://github.com/pearofducks/foodprocessor

Last synced: 25 days ago
JSON representation

A react/mobx javascript app for displaying recipes

• Host: GitHub
• URL: https://github.com/pearofducks/foodprocessor
• Owner: pearofducks
• License: mit
• Created: 2016-08-06T10:35:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2016-09-15T09:45:56.000Z (almost 8 years ago)
• Last Synced: 2024-02-21T09:34:09.177Z (4 months ago)
• Language: JavaScript
• Homepage: http://pearofducks.github.io
• Size: 9.77 KB
• Stars: 47
• Watchers: 6
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-recipes - foodprocessor - A react/mobx javascript app for displaying recipes. (Tools)
• awesome-starred - pearofducks/foodprocessor - A react/mobx javascript app for displaying recipes (others)
• awesome-stars - foodprocessor

README

        
# foodprocessor

A react/mobx javascript app for displaying recipes. Recipes are loaded from a static JSON file, so no API server is needed. :)

## build

The demo site currently uses the _master_ branch, but for a *much* smaller build (with very few changes) you can look at the _preact_ branch.

## the recipe file

- Recipe files are in YAML format with the suffix `.recipe` - example file [here](https://github.com/pearofducks/foodprocessor/blob/master/applePie.recipe)

- A crystal-based YAML to JSON converter is included, by any sane YAML to JSON converter can be used

- `name`, `what`, and `how` are required blocks

- The `what` block:

  - will accept one layer of nesting - to specify groups/sections of ingredients

  - will automatically format text provided as `INGREDIENT - OPTIONAL_MODIFICATION: QUANTITY MEASURE` - e.g. `apples - thinly sliced: 6 c`

    - known measures for expansion can be seen [here](https://github.com/pearofducks/foodprocessor/blob/master/src/components.jsx#L131), unknown measure are simply passed on

- The `how` block is purely translated into Markdown