Tom-Camp / opencocktail

A collection of cocktail recipes using an open format.
Creative Commons Zero v1.0 Universal
0 stars 0 forks source link

OpenCocktail Library

Firewater

Didn't use to take my whiskey with ice
But old age changes many things.
The other night I banked the fire
Shut the dampers down, sat in my chair,
A tall glass of mind-quiet at my side.
I took a sup and closed my eyes and thought
Of nothing much past warmth and sleep.
Then ice and locust popped at once, loud,
Then fire and ice relaxed together
In glass and stove like good old friends.
Whiskey and wood heat warms a man's insides - and outs -
And sure nuff comforts like a winter coat -
And helps somehow span the darksome night.

- Posey Green

A collection of cocktail recipes using the OpenCocktail recipe format base off of Techhat's Open Recipe Format.

Prerequisites

You will need to know a few cocktail recipes. If you don't know any, well, you've come to the right place.

Contributing

Coding

First, install Pre-commit. Once pre-commit is installed, in the project root directory run:

pre-commit install

When you make a commit the following hooks will run against your changes:

The first two will make changes to your files if needed and you will need to run your commit again in order for those changes to take. If you have schema errors you will need to correct those before and run your commit until they are fixed.

Creating

Create recipes using the schema outline in the schema.json file. Add new recipes to the recipes directory. The basic format is as follows:

---
drink_name: Gin & Tonic
ingredients:
- gin:
    amounts:
      - amount: 2.5
        unit: ounce
- tonic water:
    amounts:
      - amount: 4
        unit: ounce
drink_type: tonic
garnish: Garnish with a slice of lime.
serve_in: collins glass
steps:
  - step: Add gin to a collins glass.
  - step: Add tonic water.
source_book:
  authors:
  - Some Person
  title: Gin and Tonic for Dummies
  isbn: '1234567890'

Git workflow

Testing

Mix one or more of the cocktails and then test them.

Authors

License

This project is licensed under CC0 1.0 Universal