There are two ways to use Brauhaus.js - either in a web browser (client-side) or on e.g. Node.js (server-side).
To use Brauhaus.js in a web browser, simply download the following files and include them as you would any other script:
For Node.js, you can easily install Brauhaus.js using
npm install brauhaus-beerxml
// The following lines are NOT required for web browser usevar Brauhaus = ;;var beerxml = '<recipes><recipe><name>Test Recipe</name>...</recipe></recipes>';// Get a list of recipesvar recipes = BrauhausRecipe;console;var r = recipes0;console;
// The following lines are NOT required for web browser usevar Brauhaus = ;;// Create a recipevar r =name: 'My test brew'description: 'A new test beer using Brauhaus.js!'batchSize: 200boilSize: 100;// Add ingredientsr;r;r;// Set up a simple infusion mashrmash =name: 'My mash'ph: 54;rmash;// Print out BeerXML for the recipeconsole
A beer recipe, containing ingredients like fermentables, spices, and yeast. Calculations can be made for bitterness, alcohol content, color, and more.
Get a list of recipes from BeerXML loaded as a string.
>>> xml = '<recipes><recipe><name>Test Recipe</name>...</recipe></recipes>'>>> recipe = BrauhausRecipe0<BrauhausRecipe object 'Test Recipe'>
Convert this recipe into BeerXML for export. Returns a BeerXML string.
>>> recipe'<?xml version="1.0"><recipes><recipe>...</recipe></recipes>'
Contributions are welcome - just fork the project and submit a pull request when you are ready!
First, create a fork on GitHub. Then:
git clone ...cd brauhaus-beerxmlnpm install
Brauhaus uses the CoffeeScript Style Guide with the following exceptions:
cake build or
npm test you will see the output of CoffeeLint, a static analysis code quality tool for CoffeeScript. Please adhere to the warnings and errors to ensure your changes will build.
Before submitting a pull request, please add any relevant tests and run them via:
If you have PhantomJS installed and on your path then you can use:
CI=true npm test
Pull requests will automatically be tested by Travis CI both in Node.js 0.6/0.8/0.10 and in a headless webkit environment (PhantomJS). Changes that cause tests to fail will not be accepted. New features should be tested to be accepted.
New tests can be added in the
test directory. If you add a new file there, please don't forget to update the
test.html to include it!
You can generate a unit test code coverage report for unit tests using the following:
You can find an HTML report in the
coverage directory that is created. This report will show line-by-line code coverage information.
Please note that all contributions will be licensed under the MIT license in the following section.
Copyright (c) 2013 Daniel G. Taylor
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.