Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.47 KB

README.md

File metadata and controls

60 lines (41 loc) · 1.47 KB
Raw

Recipes

What is this

Just a small website based recipe collection for me.

How does it look

Check out the live version at https://sandr0.xyz/recipes/

How can I use it

Clone/fork this rep.

Run:

yarn install
make build
make start

Or download the artifact from GitHub.

How can I add recipes

Recipe

  • Add <name>.json to recipes.
  • It has to contain the following fields:
{
  "name": "<The name of your recipe>",
  "portions": "<optional>",
  "tags": ["<tag1>", "<tag2>", ],
  "ingredients": [
    {
      "id": "<id, Used for preparation. If a recipe with that id exists, it will automatically get linked>",
      "amount": "<optional>",
      "name": "<name which is displayed>"
    },
    {
    }
  ],
  "preparation": ["<first step>", "<second step>", ]
}
  • It is possible to link ingredients in your preparation by using {id} or {id:amount} in preparation. Example: You have an ingredient with "id": "salt". Now you can use {salt} in preparation.

Contribution

Feel free to give me a PR (or write me at Twitter: @Sandr0x00), if you got a nice recipe, or want to improve the code. I always try new stuff. I kind of think,someday I will be a better cook than programmer.

Currently, all recipes are written in german, but maybe someday, someone will translate them :)

Author

Sandro Bauer