API for the Beerio web application
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
manual
src
test
.babelrc
.esdoc.json
.eslintrc.js
.gitignore
.travis.yml
CHANGELOG.md
LICENSE.txt
README.md
apiary.apib
dredd.yml
gulpfile.babel.js
package.json

README.md

Beerio API

Build Status Dependency Status devDependency Status document Known Vulnerabilities

This project uses the following tools:

 - ECMAScript6      # Written in ES6 (ES2015)
 - ExpressJS        # Web development framework
 - Passport         # Authentication middleware
 - MongoDB          # Document store database
 - Gulp             # Build system
 - BabelJS          # JavaScript compiler
 - Travis-CI        # Continuous Integration
 - Apiary           # RESTfull API documentation
 - Dredd            # RESTfull testing
 - ESDoc            # Inline documentation
 - ESLint           # JavaScript linter

Installation

  1. Install MongoDB including.
  2. Install NodeJS.
  3. Clone the repository with: git clone https://github.com/SCThijsse/beerio-api.git.
  4. Install gulp globally with [sudo] npm install -g gulp.
  5. Install dependencies of Beerio API with cd beerio-api and npm install.
  6. Build the ES5 code with gulp build.

Manual

Checkout the manual to find out more about this project. Or checkout the documentation for the API routes here.

License

MIT License

Copyright (c) 2017 - Sjoerd Thijsse

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.