Skip to content
This repository has been archived by the owner on Sep 11, 2018. It is now read-only.

Latest commit

 

History

History
95 lines (63 loc) · 3.84 KB

README.md

File metadata and controls

95 lines (63 loc) · 3.84 KB

spa-boilerplate

Boilerplate for Single Page Applications built on top of AngularJS and browserify. Covers building application in separate environments, dependency management, directory structure and coding conventions.

Live demo...

...is here

Browser libraries included by defaut

In-browser dependencies are managed by bower. By default boilerplate uses:

  • AngularJS 1.3
  • jQuery 2.1 (can be removed if not needed)
  • angular-ui-router bower package

To install additional libraries, use bower with --save flag and edit concat:vendor task in Gruntfile.js. After adding any new library, you have to run grunt vendor again.

$ bower install --save moment.js

Build system

Code is organized in CommonJS modules. These are bundled altogether by browserify. Build tasks are defined in Gruntfile.js. Default grunt task runs server on localhost:8000 and automatically rebuilds application on any source change. Rebuilded application is pushed into browser right away (livereload).

Significant tasks:

  • grunt build-dev, grunt build-prod - build application in dev/prod mode
  • grunt lint - lint project using .jshintrc file (default included in project)
  • grunt vendor - reinstall and rebundle JavaScript vendors
  • grunt publish - synchronize public/ with S3 bucket
  • grunt - serve application with livereload

When extending Gruntfile.js with other npm packages, use --save-dev flag:

$ npm install grunt-contrib-sass --save-dev

CSS bundle is created by concatenation of all CSS files in lib/ dictionary.

Directory structure

  • config/ - configuration files
  • fronts/ - raw versions of *.html files
  • lib/{module-name}/ - module files (*.js, *.css, *.html)
  • lib/{module-name}/tpl - templates (*.html) for module, these can be required as string (require('./tpl/list.html)
  • lib/{module-name}/controllers, lib/{module-name}/directives - AngularJS specific code
  • public/ - bundled application files, can be used as webroot or synchronized with some cloud storage (eg. S3 bucket)

Getting started

You only have to have node.js installed. bower and browserify are installed locally.

$ git clone [email protected]:jelz/spa-boilerplate.git
$ cd spa-boilerplate
$ cp config/config.json.dist config/config.json
$ npm install
$ grunt

Adding new module

  • create lib/{module-name}/ directory with index.js file in there
  • create AngularJS module in this file, export it from the module (module.exports = ...;)
  • update lib/app/modules.js, add dependency to main AngularJS module in lib/app/index.js

S3 synchronization

Use grunt publish to push code into S3 bucket. Provide AWS credentials and configuration in config/aws.json.

$ cp config/aws.json.dist config/aws.json
$ vi config/aws.json
$ grunt publish

Only changed files will be pushed. Bucket has to exist. No policy or website configuration will be added.

Token-based auth

UserState Angular service provides basic token-based authentication flow. Calling UserState.login() redirects user to login service page (loginUrl in config.json) with query string parameter ?redirect_uri=.... This service should authenticate user, issue a token and call SPA back with it:

  • if redirect_uri is a domain name without trialing slash, it should be appended with /#___{token-value}
  • if redirect_uri ends with slash or file name, it should be appended with #___{token-value}
  • if redirect_uri contains hash (#), then it should be appended with ___{token-value}

Any further $http requests will have X-Access-Token (can be changed in config.json - tokenHeaderName property) header set. Calling UserState.logout() clears all user-related data.

public/login/mock/login.js implements mocked login flow.

License

MIT