Install with npm:
npm install --save angular-eha.cordova.camera
Or alternatively bower:
bower install --save angular-eha.cordova.camera
The distribution bundle comes in 2 flavours, one with templates, one without - as well as providing both minified and unminfied versions of both, so take your pick:
Then simply add
eha.cordova.camera.templates (if you want templates!) as dependencies somewhere in your project that makes sense and you're good to go.
A note on wiredep
If you're using wiredep
dist/angular-eha.cordova.camera.template.js will be injected by default. If you don't want that to happen you'll like want to employ something along the following lines in your
Then you're free to include whichever bundle you prefer in what ever manner you prefer.
- Firefox (for running test suite)
- node (0.12.0)
- bower (1.3.12)
- grunt-cli (0.1.7)
- grunt (0.4.5)
# Fork the upstream repo on github and pull down your forkgit clone firstname.lastname@example.org:yourusername/angular-eha.cordova.camera.git# change into project foldercd angular-eha.cordova.camera# Add the upstream as a remotegit remote add upstream email@example.com:eHealthAfrica/angular-eha.cordova.camera.git# Install the dev dependenciesnpm install
The test suite is configured to run in Firefox and is powered by:
- Chai (as promised)
- Sinon (chai)
The library is conducive to TDD.
grunt test:watch is your friend. As modules (and templates) are exposed on their own namespaces you can easily isolate areas of the codebase for true unit testing without being forced to pull in the whole library or stub/mock modules irrelevent to the feature(s) you're testing.
Transpiling templates (html2js)
Transpiling our html templates into js allows us to neatly push them into the
To transpile the templates it's another simple grunt command:
This will compile the templates to the
dist/ folder. But it's probably best to avoid this all together. Both the
grunt test and
grunt release commands take care of all of this for you.
If you need to override the default template, simply replace what's already in the
$templateCache with what ever you want. One way to achieve this is like this:
To make a release, ensure you have issued
grunt build, committed the distribution package and tagged the commit with an appropriate version according to the SemVer spec.
To make this easy for you, there's a handy grunt task. Simply issue
grunt release:major|minor|patch and grunt will take care of building, committing and tagging for you. Then make a PR to the master branch of the upstream, merge upon CI build success and then all that's left to do is to push the tags to the upstream.
grunt release:minorgit pull-request -b eHealthAfrica:mastergit push upstream --tags
Publishing to npm
To publish a new version to npm, simply issue from the command line prior making a release (i.e.issuing a
grunt release and pushing both commits and tags to the upstream):
Publishing to bower
Publishing to bower is slightly simpler in so far that you only have to do it once, and not explicitly for every release like npm:
bower register angular-eha.cordova.camera https://github.com/eHealthAfrica/angular-eha.cordova.cameragit
Copyright 2015 Matt Richards (eHealthAfrica)
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.