baw-client

The AngularJS client for the acoustic workbench

Install instructions

node and npm are required to build this project.

Before you get started make sure you have at least version 4 or above of node.js. We also require npm version 3 or above.

To install project dependencies run:

$ npm install

This will execute npm install and bower install to install build and vendor dependencies respectively.

To develop:

$ npm start

and browse to the karma tab first localhost:<port> (see output for port number), then localhost:8080 after the karma unit tests have run.

To add new build packages

$ npm install packageName --save-dev

To add new bower packages

$ bower install packageName --save-dev

You'll need to configure build.config.js when adding any new grunt packages to the vendor directory.

To build:

$ npm run build

and copy the artifacts from the /bin directory.

npm run build passes arguments to the grunt build tool. The grunt runner will accept three build options that will rewrite important variables for different environments.

• development: $ grunt --development
  • execute $ npm run build -- --development
• staging: $ grunt --staging
  • execute $ npm run build -- --staging
• production (the default): $ grunt --production
  • execute $ npm run build -- --production

These environments are configured in buildConfig/environmentSettings.json. We recommend you keep a private version of the environmentsSettings.json that are specific to your organization and temporarily replace this repository's copy when you do a production build.

Additionally, the grunt command will accept a --use-phantomjs JS options which will switch the default karma test runner from Chrome to PhantomJS.

Commits and CHANGELOG

Our changelog is automatically generated using conventional changelog.

Commits must follow the conventions listed here: https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md

To make a release

You'll need write permissions to this repository to make a release.

1. Ensure your current branch is master
2. Ensure your working directory is clean
3. Ensure you've updated, do a git pull
4. Then finally run grunt release
   • Where arguments are defined by https://github.com/vojtajina/grunt-bump
   • Examples
     • grunt release:patch
     • grunt release:minor
     • grunt release:major
     • grunt release --setversion=1.0.0

To bump the version, without changing anything other than the version (no changelog, not commits, no tags), run:

$ grunt bump-only:<<argument>>

Licence

Apache License, Version 2.0

Based on the ng-boilerplate library.