afb-client/bower_components/foundation-apps/README.md

   1 # Foundation for Apps
   2
   3 [![Build Status](https://travis-ci.org/zurb/foundation-apps.svg)](https://travis-ci.org/zurb/foundation-apps)
   4
   5 This is [Foundation for Apps](http://foundation.zurb.com/apps), an Angular-powered framework for building powerful responsive web apps, from your friends at [ZURB](http://zurb.com).
   6
   7 ## Requirements
   8
   9 You'll need the following software installed to get started.
  10
  11   * [Node.js](http://nodejs.org): Use the installer provided on the NodeJS website.
  12   * [Git](http://git-scm.com/downloads): Use the installer for your OS.
  13     * Windows users can also try [Git for Windows](http://git-for-windows.github.io/).
  14   * [Ruby](https://www.ruby-lang.org/en/): Use the installer for your OS. For Windows users, [JRuby](http://jruby.org/) is a popular alternative.
  15     * With Ruby installed, run `gem install bundler sass`.
  16   * [Gulp](http://gulpjs.com/) and [Bower](http://bower.io): Run `[sudo] npm install -g gulp bower`
  17
  18 ## Get Started
  19
  20 The Sass and JavaScript components are available on Bower and npm.
  21 ```
  22 bower install foundation-apps --save
  23 npm install foundation-apps --save
  24 ```
  25
  26 You can also use our command-line interface to quickly setup a basic Foundation for Apps project. It includes a pre-built Gulpfile that compiles an Angular-powered web app for you.
  27
  28 Install it with this command:
  29 ```
  30 npm install -g foundation-cli bower gulp
  31 ```
  32
  33 Now you can make a new project:
  34 ```
  35 foundation-apps new myApp
  36 cd myApp
  37 ```
  38
  39 While working on your project, run:
  40 ```
  41 npm start
  42 ```
  43
  44 This will assemble the templates, static assets, Sass, and JavaScript. You can view the test server at this URL:
  45 ```
  46 http://localhost:8080
  47 ```
  48
  49 ## Building this Repo
  50
  51 If you want to work with the source code directly or compile our documentation, follow these steps:
  52 ```
  53 git clone https://github.com/zurb/foundation-apps.git
  54 cd foundation-apps
  55 npm install
  56 ```
  57
  58 While you're working on the code, run:
  59 ```
  60 npm start
  61 ```
  62
  63 The documentation can be viewed at the same URL as above.
  64
  65 ### Directory Structure
  66
  67 * `build`: This is where our documentation is assembled. **Don't edit these files directly, as they're overwritten every time you make a change!**
  68 * `docs`: The Foundation for Apps documentation.
  69 * `scss`: The Sass components.
  70 * `js`: The Angular modules and directives, and other external libraries.
  71 * `iconic`: A set of 24 icons from the folks at [Iconic](https://useiconic.com/).
  72 * `dist`: Compiled CSS and JavaScript files, in minified and unmified flavors.
  73 * `tests`: Unit tests for the Angular modules.
  74
  75 ## Versioning
  76
  77 Foundation for Apps follows semver, so we won't introduce breaking changes in minor or patch versions. The `master` branch will always have the newest changes, so it's not necessarily production ready. The `stable` branch will always have the most recent stable version of the framework.
  78
  79 ## Contributing
  80
  81 We love feedback! Help us find bugs and suggest improvements or new features. Follow us on Twitter at [@ZURBFoundation](https://twitter.com/zurbfoundation) to keep up-to-date with what's new, or to just shoot the breeze.
  82
  83 If you find a problem or have an idea, open a [new issue](https://github.com/zurb/foundation-apps/issues) on GitHub. When filing a bug report, make sure you specify the browser and operating system you're on, and toss us a screenshot or show us how we can recreate the issue.