angular-eha.login-service

Usage

Installation

Install with npm:

npm install --save angular-eha.login-service

Or alternatively bower:

bower install --save angular-eha.login-service

Distribution bundle

dist/login-service.js
dist/login-service.min.js

Then simply add eha.login-service 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/login-service.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 Gruntfile:

wiredep: {
 ...
  options: {
    exclude: [
      'bower_components/login-service/dist/login-service.js'
    ]
  }
  ...
}

Then you're free to include whichever bundle you prefer in what ever manner you prefer.

Example

<html ng-app="backButtonExample">
  <head>
    <title>Back Button Example</title>
    <script src="bower_components/angular/angular.js"></script>
    <script src="bower_components/angular-eha.login-service/dist/login-service.js"></script>
    <script>
    angular.module('backButtonExample', [
      'eha.login-service'
    ]);
    </script>
  </head>
  <body>
    <!-- Put an example here! -->
  </body>
</html>

Contributing

Prerequisites

Firefox (for running test suite)
node (0.12.0)
bower (1.3.12)
grunt-cli (0.1.7)
grunt (0.4.5)

Installation

# Fork the upstream repo on github and pull down your fork
git clone [email protected]:yourusername/angular-eha.login-service.git
# change into project folder
cd angular-eha.login-service
# Add the upstream as a remote
git remote add upstream  [email protected]:eHealthAfrica/angular-eha.login-service.git
# Install the dev dependencies
npm install

Docs

Code should be documented following the guidelines set out by jsdoc and ngdoc. We can then leverage Dgeni or something simlary to generate documentation in any format we like.

Test Suite

The test suite is configured to run in Firefox and is powered by:

Karma
Mocha
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 namespace you can easily isolate areas of the code base for true unit testing without being forced to pull in the whole library or stub/mock modules irrelevant to the feature(s) you're testing.

Running Tests

Single run

grunt test

Watch

grunt test:watch

Local Development

Local development is made easy, simply make use of either npm link or bower link to link the local component to your client application and then use grunt watch to continuously build the project.

Transpiling templates (html2js)

Transpiling our html templates into js allows us to neatly push them into the $templateCache.

To transpile the templates it's another simple grunt command:

grunt templates

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:

<script id="templates/back-button.directive.tpl.html" type="text/html">
    <button>I'm a button!</button>
</script>

Release Process

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.

e.g:

  grunt release:minor
  git pull-request -b <upstream_repo>:master
  git 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):

npm publish

### 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:

e.g.

bower register angular-eha.login-service <upstream_repo_url>

License

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

http://www.apache.org/licenses/LICENSE-2.0

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.

tlvince / angular-eha.login-service Goto Github PK