git.rot13.org Git - angular-drzb/blob - README.md

   1 # angular-seed — the seed for AngularJS apps
   2
   3 This project is an application skeleton for a typical [AngularJS](http://angularjs.org/) web app.
   4 You can use it to quickly bootstrap your angular webapp projects and dev environment for these
   5 projects.
   6
   7 The seed contains angular libraries, test libraries and a bunch of scripts all preconfigured for
   8 instant web development gratification. Just clone the repo (or download the zip/tarball), start up
   9 our (or yours) webserver and you are ready to develop and test your application.
  10
  11 The seed app doesn't do much, just shows how to wire two controllers and views together. You can
  12 check it out by opening app/index.html in your browser (might not work file `file://` scheme in
  13 certain browsers, see note below).
  14
  15 _Note: While angular is client-side-only technology and it's possible to create angular webapps that
  16 don't require a backend server at all, we recommend hosting the project files using a local
  17 webserver during development to avoid issues with security restrictions (sandbox) in browsers. The
  18 sandbox implementation varies between browsers, but quite often prevents things like cookies, xhr,
  19 etc to function properly when an html page is opened via `file://` scheme instead of `http://`._
  20
  21
  22 ## How to use angular-seed
  23
  24 Clone the angular-seed repository and start hacking...
  25
  26
  27 ### Running the app during development
  28
  29 You can pick one of these options:
  30
  31 * serve this repository with your webserver
  32 * install node.js and run `scripts/web-server.js`
  33
  34 Then navigate your browser to `http://localhost:<port>/app/index.html` to see the app running in
  35 your browser.
  36
  37
  38 ### Running the app in production
  39
  40 This really depends on how complex is your app and the overall infrastructure of your system, but
  41 the general rule is that all you need in production are all the files under the `app/` directory.
  42 Everything else should be omitted.
  43
  44 angular apps are really just a bunch of static html, css and js files that just need to be hosted
  45 somewhere, where they can be accessed by browsers.
  46
  47 If your angular app is talking to the backend server via xhr or other means, you need to figure
  48 out what is the best way to host the static files to comply with the same origin policy if
  49 applicable. Usually this is done by hosting the files by the backend server or through
  50 reverse-proxying the backend server(s) and a webserver(s).
  51
  52
  53 ### Running unit tests
  54
  55 We recommend using [jasmine](http://pivotal.github.com/jasmine/) and
  56 [JsTestDriver](http://code.google.com/p/js-test-driver/) for your unit tests/specs, but you are free
  57 to use whatever works for you.
  58
  59 Requires java and a local or remote browser.
  60
  61 * start `scripts/test-server.sh` (on windows: `scripts\test-server.bat`)
  62 * navigate your browser to `http://localhost:9876/`
  63 * click on one of the capture links (preferably the "strict" one)
  64 * run `scripts/test.sh` (on windows: `scripts\test.bat`)
  65
  66
  67 ### Continuous unit testing
  68
  69 Requires ruby and [watchr](https://github.com/mynyml/watchr) gem.
  70
  71 * start JSTD server and capture a browser as described above
  72 * start watchr with `watchr scripts/watchr.rb`
  73 * in a different window/tab/editor `tail -f logs/jstd.log`
  74 * edit files in `app/` or `src/` and save them
  75 * watch the log to see updates
  76
  77 There are many other ways to achieve the same effect. Feel free to use them if you prefer them over
  78 watchr.
  79
  80
  81 ### End to end testing
  82
  83 angular ships with a baked-in end-to-end test runner that understands angular, your app and allows
  84 you to write your tests with jasmine-like BDD syntax.
  85
  86 Requires a webserver, node.js or your backend server that hosts the angular static files.
  87
  88 Check out the
  89 [end-to-end runner's documentation](http://docs.angularjs.org/guide/dev_guide.e2e-testing) for more
  90 info.
  91
  92 * create your end-to-end tests in `test/e2e/scenarios.js`
  93 * serve your project directory with your http/backend server or node.js + `scripts/web-server.js`
  94 * to run do one of:
  95   * open `http://localhost:port/test/e2e/runner.html` in your browser
  96   * run the tests from console with [Testacular](vojtajina.github.com/testacular) via
  97     `scripts/e2e-test.sh` or `script/e2e-test.bat`
  98
  99
 100 ### Receiving updates from upstream
 101
 102 When we upgrade angular-seed's repo with newer angular or testing library code, you can just
 103 fetch the changes and merge them into your project with git.
 104
 105
 106 ## Directory Layout
 107
 108     app/                --> all of the files to be used in production
 109       css/              --> css files
 110         app.css         --> default stylesheet
 111       img/              --> image files
 112       index.html        --> app layout file (the main html template file of the app)
 113       js/               --> javascript files
 114         controllers.js  --> application controllers
 115         filters.js      --> custom angular filters
 116         services.js     --> custom angular services
 117         widgets.js      --> custom angular widgets
 118       lib/              --> angular and 3rd party javascript libraries
 119         angular/
 120           angular.js            --> the latest angular js
 121           angular.min.js        --> the latest minified angular js
 122           angular-*.js  --> angular add-on modules
 123           version.txt           --> version number
 124       partials/         --> angular view partials (partial html templates)
 125         partial1.html
 126         partial2.html
 127
 128     config/jsTestDriver.conf    --> config file for JsTestDriver
 129
 130     logs/               --> JSTD and other logs go here (git-ignored)
 131
 132     scripts/            --> handy shell/js/ruby scripts
 133       e2e-test.sh       --> runs end-to-end tests with Testacular (*nix)
 134       e2e-test.bat      --> runs end-to-end tests with Testacular (windows)
 135       test-server.bat   --> starts JSTD server (windows)
 136       test-server.sh    --> starts JSTD server (*nix)
 137       test.bat          --> runs all unit tests (windows)
 138       test.sh           --> runs all unit tests (*nix)
 139       watchr.rb         --> config script for continuous testing with watchr
 140       web-server.js     --> simple development webserver based on node.js
 141
 142     test/               --> test source files and libraries
 143       e2e/              -->
 144         runner.html     --> end-to-end test runner (open in your browser to run)
 145         scenarios.js    --> end-to-end specs
 146       lib/
 147         angular/                --> angular testing libraries
 148           angular-mocks.js      --> mocks that replace certain angular services in tests
 149           angular-scenario.js   --> angular's scenario (end-to-end) test runner library
 150           version.txt           --> version file
 151         jasmine/                --> Pivotal's Jasmine - an elegant BDD-style testing framework
 152         jasmine-jstd-adapter/   --> bridge between JSTD and Jasmine
 153         jstestdriver/           --> JSTD - JavaScript test runner
 154       unit/                     --> unit level specs/tests
 155         controllersSpec.js      --> specs for controllers
 156
 157 ## Contact
 158
 159 For more information on angular please check out http://angularjs.org/