Skip to content

Latest commit

 

History

History
110 lines (87 loc) · 3.76 KB

README.md

File metadata and controls

110 lines (87 loc) · 3.76 KB
Raw

Avalanche Canada

Build Status ![dependencies] (https://david-dm.org/avalanchedotca/avalanchecanada.png)

Introduction

The AvalancheCanada website is a implementation of a front end/view upon CAC data streams. Data is stored separately to the website and is available via RESTful API’s.
Design still under way.
Contact [email protected] for more details or to get invoved.

Technical Architecture

The Avalanche Canada website is a AngularJS project.
Based of ngBoilerplate kickstarter.
Angular UI.
Angular Bootstrap Font Awesome
Grunt-based build system to ensure maximum productivity.
Bower package management Compass
SASS
[Travis CI] (https://travis-ci.org/avalanchedotca/AvalancheCanada) Continuous Integration and Deployment.

Modules

Quick Start

Install Node.js and Ruby then:

$ gem install compass
$ sudo npm -g install grunt-cli karma bower 
$ npm install
$ bower install
$ grunt watch

Finally, open file:///path/to/ng-boilerplate/build/index.html in your browser.

Overall Directory Structure

At a high level, the structure looks roughly like this:

AvalancheCanada/
  |- grunt-tasks/
  |- karma/
  |- src/
  |  |- app/
  |  |  |- <app logic>
  |  |- assets/
  |  |  |- <static files>
  |  |- common/
  |  |  |- <reusable code / directives>
  |  |- sass/
  |  |  |- main.scss
  |- vendor/
  |- .bowerrc
  |- bower.json
  |- build.config.js
  |- Gruntfile.js
  |- module.prefix
  |- module.suffix
  |- package.json

What follows is a brief description of each entry, but most directories contain their own README.md file with additional documentation, so browse around to learn more.

  • karma/ - test configuration.
  • src/ - our application sources. Read more »
  • vendor/ - third-party libraries. Bower will install packages here. Anything added to this directory will need to be manually added to build.config.js and karma/karma-unit.js to be picked up by the build system.
  • .bowerrc - the Bower configuration file. This tells Bower to install components into the vendor/ directory.
  • bower.json - this is our project configuration for Bower and it contains the list of Bower dependencies we need.
  • build.config.js - our customizable build settings; see "The Build System" below.
  • Gruntfile.js - our build script; see "The Build System" below.
  • module.prefix and module.suffix - our compiled application script is wrapped in these, which by default are used to place the application inside a self-executing anonymous function to ensure no clashes with other libraries.
  • package.json - metadata about the app, used by NPM and our build script. Our NPM dependencies are listed here.

Roadmap

To Do

See the issues list. And feel free to submit your own!

Contributing

We welcome contributions..
Please feel free to suggest an improvement via a pull request, report any issues via issues list, join the discussion at discussion group or contact the developers at [email protected]

Questions/Contact

For any question please do not hesitate to contact [email protected]