Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/homebrewing/tapline
A homebrew beer recipe API server backed by MongoDB
https://github.com/homebrewing/tapline
Last synced: 3 months ago
JSON representation
A homebrew beer recipe API server backed by MongoDB
- Host: GitHub
- URL: https://github.com/homebrewing/tapline
- Owner: homebrewing
- Created: 2013-06-28T16:21:39.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-02-01T16:16:09.000Z (almost 6 years ago)
- Last Synced: 2024-04-14T03:59:59.713Z (10 months ago)
- Language: CoffeeScript
- Size: 539 KB
- Stars: 27
- Watchers: 12
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Tapline
=======
[](https://david-dm.org/homebrewing/tapline) [](https://travis-ci.org/homebrewing/tapline) [](https://coveralls.io/r/homebrewing/tapline?branch=master) [](http://badge.fury.io/js/tapline)
A beer, wine, and mead homebrew API server based on [Brauhaus](https://github.com/homebrewing/brauhausjs). Features include:
* Anonymous, public access to homebrewing calculators and converters
* Account registration, authentication & authorization
* Recipe storage & retrieval
* Recipe history (like Github for beer)
* Persistent storage via [MongoDB](http://www.mongodb.org/)
* Social features
* Follow other brewers
* Clone and share recipes
* Open source, MIT licensed
Planned features include:
* Recipe search
* Brew logs
Tapline was developed with and for [Malt.io](http://www.malt.io/), a community website for homebrewers to create recipes and share their love of homebrewing beer.
The Tapline name was chosen because like a central tap line, this project provides a connection between storage (kegs) and serving requests (taps to fill beers).
Documentation
-------------
The Tapline API documentation is in a separate document to keep the reference as slim as possible. For now it is stored in a static file, but in the future may include a way to do example calls.
* Read the [Tapline API documentation](https://api.malt.io/)
Dependencies
------------
Please ensure that you have the following installed / running:
* [Node.js](http://nodejs.org/)
* [MongoDB](http://www.mongodb.org/)
* [Beanstalkd](http://kr.github.io/beanstalkd/)
Installation
------------
For Node.js, you can easily install Tapline using `npm`:
```bash
npm install -g tapline
```
Note: Depending on your system you may need to use `sudo` to run the above command.
Running the Server
------------------
Tapline installs a new command, called `tapline`, that will let you run the server. It is recommended that for production use you use an Upstart or init script and daemonize the process. During testing or development it is sufficient to run the following:
```bash
tapline
```
By default, Tapline will run on http://localhost:2337/ (the port spells 'beer' on a typical phone)
Contributing
------------
Contributions are welcome - just fork the project and submit a pull request when you are ready!
### Getting Started
First, create a fork on GitHub. Also, make sure you have Grunt. MongoDB and beanstalkd will be started for you, just make sure they are installed locally.
```bash
# Install grunt if you don't already have it
npm install -g grunt-cli
# Setup tapline
git clone ...
cd tapline
npm install
...
npm start
```
### Style Guide
Tapline uses the [CoffeeScript Style Guide](https://github.com/polarmobile/coffeescript-style-guide) with the following exceptions:
1. Indent 4 spaces
1. Maximum line length is 120 characters
When building with `cake build` or `npm test` you will see the output of [CoffeeLint](http://www.coffeelint.org/), a static analysis code quality tool for CoffeeScript. Please adhere to the warnings and errors to ensure your changes will build.
### Unit Tests
Before submitting a pull request, please add any relevant tests and run them via:
```bash
npm test
```
Pull requests will automatically be tested by Travis CI Node.js 0.8/0.10. 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.
### Code Coverage
You can generate a unit test code coverage report for unit tests using the following:
```bash
grunt mochacov:html
```
You can find an HTML report in the `coverage.html` file. 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.
License
-------
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.