andrewholgate/who-hand-hygiene-survey

Hand hygiene survey app based on the World Health Organisation's Five Moments for Hand Hygiene.

The WHO Hand Hygiene Survey is a mobile friendly tool for performing hand hygiene in hospitals in accordance with the World Health Oragnisation: Five Moments of Hand Hygiene.

• HTML5, CSS and JavaScript only.
• Works on all modern web browsers:
  • Chrome
  • Firefox
  • Safari
  • IE 9+
• Works on desktop, tablets and mobile devices.
• Uses browser's native localStorage for all data.

Technology

• Bootstrap 3.x for responsive look-and-feel.
• jQuery 1.x for DOM manipulation (1.x is used for older Internet Explorer compatability)
• BackboneJS 1.x and UnderscoreJS for managing application logic and visualisation.
• BackboneJS LocalStorage 1.x to allow local storage of data through Backbone.
• RequireJS 2.x for Javascript libary dependency management and optimisation.
• RequireJS Text 2.x for loading HTML templates.

Development Environment

• NodeJS runtime environment for server-side.
• Grunt for development task running.

Standards Used

• Code using JavaScript Strict mode.
• Conforms to jQuery coding style guide.
• HTML5 valid.

Developer Setup

Installation

You will need to install NodeJS and npm.

# Install Grunt CLI for task running.
npm install -g grunt-cli

# Install project.
npm install

# Install functional testing tools
npm install -g phantomjs
npm install -g casperjs

# Build the project
grunt build

Start Application Server

# Start and watch server.
grunt

Run Tests

# Run all project tests.
grunt test

TODO

• Add meta data for OG, etc.
• Improve development build.
• Add bookmark images, such as apple-touch-icon-precomposed.
• Functional tests for survey
• Unit tests

Potential Optimisations

• Remove dependency on jQuery
• Remove dependency on RequireJS
• Remove dependency on RequireJS Text