Home Reference Source Repository
Manual » Usage

Usage

In this usage section you can read about Beerio API and its functionality through the CLI.

npm

The following commands are defined in the package.json:

 $ npm run build                        # Build the project (same as $ gulp build).
 $ npm run dev                          # Run the development version of the API.
 $ npm run dist                         # Run the build version of the API.
 $ npm run docs                         # Generate documenation of the API.
 $ npm run forever                      # Run the API with the 'forever' module.
 $ npm run lint                         # Lint code with eslint.
 $ npm run test                         # Run tests with dredd.

Gulp

The following commands are defined by Gulp:

 $ gulp build                           # Transpile the ES6 source code to ES5.
 $ gulp clean                           # Delete the 'build' directory.
 $ gulp default                         # The default gulp task (same as 'gulp build').
 $ gulp watch                           # Watch for any changes in the 'src' directory.