angular.js/README.md

AngularJS [![Build Status](https://travis-ci.org/angular/angular.js.png?branch=master)](https://travis-ci.org/angular/angular.js)
=========

AngularJS lets you write client-side web applications as if you had a smarter browser.  It lets you
use good old HTML (or HAML, Jade and friends!) as your template language and lets you extend HTML’s
syntax to express your application’s components clearly and succinctly.  It automatically
synchronizes data from your UI (view) with your JavaScript objects (model) through 2-way data
binding. To help you structure your application better and make it easy to test, AngularJS teaches
the browser how to do dependency injection and inversion of control. Oh yeah and it also helps with
server-side communication, taming async callbacks with promises and deferreds; and make client-side
navigation and deeplinking with hashbang urls or HTML5 pushState a piece of cake. The best of all:
it makes development fun!

* Web site: http://angularjs.org
* Tutorial: http://docs.angularjs.org/tutorial
* API Docs: http://docs.angularjs.org/api
* Developer Guide: http://docs.angularjs.org/guide
* Contribution guidelines: http://docs.angularjs.org/misc/contribute
* Dashboard: http://dashboard.angularjs.org

Building AngularJS
---------
[Once you have your environment setup](http://docs.angularjs.org/misc/contribute) just run:

    grunt package


Running Tests
-------------
To execute all unit tests, use:

    grunt test:unit

To execute end-to-end (e2e) tests, use:

    grunt package
    grunt test:e2e

To learn more about the grunt tasks, run `grunt --help` and also read our
[contribution guidelines](http://docs.angularjs.org/misc/contribute).
-												chore(readme): add Travis build status
											
										
										
											2013-08-24 16:50:13 +00:00
+								AngularJS [![Build Status](https://travis-ci.org/angular/angular.js.png?branch=master)](https://travis-ci.org/angular/angular.js)
-												chore(readme): add some links and update test commands
											
										
										
											2012-01-06 03:54:42 +00:00
+								=========
-												docs(README.md): add missing 'you' and a comma

											
										
										
											2012-12-11 09:57:41 +00:00
+								AngularJS lets you write client-side web applications as if you had a smarter browser.  It lets you
 								use good old HTML (or HAML, Jade and friends!) as your template language and lets you extend HTML’s
-												docs(readme): add blurb about AngularJS to README.md

											
										
										
											2012-07-02 15:19:14 +00:00
+								syntax to express your application’s components clearly and succinctly.  It automatically
 								synchronizes data from your UI (view) with your JavaScript objects (model) through 2-way data
-												docs(README.md): add missing 'you' and a comma

											
										
										
											2012-12-11 09:57:41 +00:00
+								binding. To help you structure your application better and make it easy to test, AngularJS teaches
-												docs(readme): add blurb about AngularJS to README.md

											
										
										
											2012-07-02 15:19:14 +00:00
+								the browser how to do dependency injection and inversion of control. Oh yeah and it also helps with
 								server-side communication, taming async callbacks with promises and deferreds; and make client-side
-												docs(readme): improve blurb about AngularJS in README.md

											
										
										
											2012-07-02 15:19:14 +00:00
+								navigation and deeplinking with hashbang urls or HTML5 pushState a piece of cake. The best of all:
 								it makes development fun!
-												docs(readme): add blurb about AngularJS to README.md

											
										
										
											2012-07-02 15:19:14 +00:00
-												chore(readme): add some links and update test commands
											
										
										
											2012-01-06 03:54:42 +00:00
+								* Web site: http://angularjs.org
-												docs(readme): add blurb about AngularJS to README.md

											
										
										
											2012-07-02 15:19:14 +00:00
+								* Tutorial: http://docs.angularjs.org/tutorial
-												docs(README.md): fix "API Docs" link

use direct link to api docs

											
										
										
											2012-10-10 03:57:58 +00:00
+								* API Docs: http://docs.angularjs.org/api
-												docs(readme): add blurb about AngularJS to README.md

											
										
										
											2012-07-02 15:19:14 +00:00
+								* Developer Guide: http://docs.angularjs.org/guide
-												docs(README): update README.md with new rake tasks

											
										
										
											2012-09-17 21:50:07 +00:00
+								* Contribution guidelines: http://docs.angularjs.org/misc/contribute
-												docs(README): add dashboard link

Closes #3934

											
										
										
											2013-09-09 09:00:19 +00:00
+								* Dashboard: http://dashboard.angularjs.org
-												readme

											
										
										
											2010-03-15 21:41:28 +00:00
-												docs(README): update README.md with new rake tasks

											
										
										
											2012-09-17 21:50:07 +00:00
+								Building AngularJS
-												readme

											
										
										
											2010-03-15 21:41:28 +00:00
+								---------
-												docs(README): update README.md with new rake tasks

											
										
										
											2012-09-17 21:50:07 +00:00
+								[Once you have your environment setup](http://docs.angularjs.org/misc/contribute) just run:
-												chore(Grunt): switch from Rake to Grunt

Migrates the Angular project from Rake to Grunt.

Benefits:
- Drops Ruby dependency
- Lowers barrier to entry for contributions from JavaScript ninjas
- Simplifies the Angular project setup and build process
- Adopts industry-standard tools specific to JavaScript projects
- Support building angular.js on Windows platform (really?!? why?!?)

BREAKING CHANGE: Rake is completely replaced by Grunt. Below are the deprecated Rake tasks and their Grunt equivalents:

rake --> grunt
rake package --> grunt package
rake init --> N/A
rake clean --> grunt clean
rake concat_scenario --> grunt build:scenario
rake concat --> grunt build
rake concat_scenario --> grunt build:scenario
rake minify --> grunt minify
rake version --> grunt write:version
rake docs --> grunt docs
rake webserver --> grunt webserver
rake test --> grunt test
rake test:unit --> grunt test:unit
rake test:<jqlite|jquery|modules|e2e> --> grunt test:<jqlite|jquery|modules|end2end|e2e>
rake test[Firefox+Safari] --> grunt test --browsers Firefox,Safari
rake test[Safari] --> grunt test --browsers Safari
rake autotest --> grunt autotest

NOTES:
* For convenience grunt test:e2e starts a webserver for you, while grunt test:end2end doesn't.
  Use grunt test:end2end if you already have the webserver running.
* Removes duplicate entry for Describe.js in the angularScenario section of angularFiles.js
* Updates docs/src/gen-docs.js to use #done intead of the deprecated #end
* Uses grunt-contrib-connect instead of lib/nodeserver (removed)
* Removes nodeserver.sh, travis now uses grunt webserver
* Built and minified files are identical to Rake's output, with the exception of one less
  character for git revisions (using --short) and a couple minor whitespace differences

Closes #199

											
										
										
											2012-10-21 06:37:59 +00:00
+								    grunt package
-												docs(README): update README.md with new rake tasks

											
										
										
											2012-09-17 21:50:07 +00:00
-												readme

											
										
										
											2010-03-15 21:41:28 +00:00
 								Running Tests
 								-------------
-												docs(README): update README.md with new rake tasks

											
										
										
											2012-09-17 21:50:07 +00:00
+								To execute all unit tests, use:
-												chore(Grunt): switch from Rake to Grunt

Migrates the Angular project from Rake to Grunt.

Benefits:
- Drops Ruby dependency
- Lowers barrier to entry for contributions from JavaScript ninjas
- Simplifies the Angular project setup and build process
- Adopts industry-standard tools specific to JavaScript projects
- Support building angular.js on Windows platform (really?!? why?!?)

BREAKING CHANGE: Rake is completely replaced by Grunt. Below are the deprecated Rake tasks and their Grunt equivalents:

rake --> grunt
rake package --> grunt package
rake init --> N/A
rake clean --> grunt clean
rake concat_scenario --> grunt build:scenario
rake concat --> grunt build
rake concat_scenario --> grunt build:scenario
rake minify --> grunt minify
rake version --> grunt write:version
rake docs --> grunt docs
rake webserver --> grunt webserver
rake test --> grunt test
rake test:unit --> grunt test:unit
rake test:<jqlite|jquery|modules|e2e> --> grunt test:<jqlite|jquery|modules|end2end|e2e>
rake test[Firefox+Safari] --> grunt test --browsers Firefox,Safari
rake test[Safari] --> grunt test --browsers Safari
rake autotest --> grunt autotest

NOTES:
* For convenience grunt test:e2e starts a webserver for you, while grunt test:end2end doesn't.
  Use grunt test:end2end if you already have the webserver running.
* Removes duplicate entry for Describe.js in the angularScenario section of angularFiles.js
* Updates docs/src/gen-docs.js to use #done intead of the deprecated #end
* Uses grunt-contrib-connect instead of lib/nodeserver (removed)
* Removes nodeserver.sh, travis now uses grunt webserver
* Built and minified files are identical to Rake's output, with the exception of one less
  character for git revisions (using --short) and a couple minor whitespace differences

Closes #199

											
										
										
											2012-10-21 06:37:59 +00:00
+								    grunt test:unit
-												docs(README): update README.md with new rake tasks

											
										
										
											2012-09-17 21:50:07 +00:00
 								To execute end-to-end (e2e) tests, use:
-												chore(readme): add some links and update test commands
											
										
										
											2012-01-06 03:54:42 +00:00
-												chore(Grunt): switch from Rake to Grunt

Migrates the Angular project from Rake to Grunt.

Benefits:
- Drops Ruby dependency
- Lowers barrier to entry for contributions from JavaScript ninjas
- Simplifies the Angular project setup and build process
- Adopts industry-standard tools specific to JavaScript projects
- Support building angular.js on Windows platform (really?!? why?!?)

BREAKING CHANGE: Rake is completely replaced by Grunt. Below are the deprecated Rake tasks and their Grunt equivalents:

rake --> grunt
rake package --> grunt package
rake init --> N/A
rake clean --> grunt clean
rake concat_scenario --> grunt build:scenario
rake concat --> grunt build
rake concat_scenario --> grunt build:scenario
rake minify --> grunt minify
rake version --> grunt write:version
rake docs --> grunt docs
rake webserver --> grunt webserver
rake test --> grunt test
rake test:unit --> grunt test:unit
rake test:<jqlite|jquery|modules|e2e> --> grunt test:<jqlite|jquery|modules|end2end|e2e>
rake test[Firefox+Safari] --> grunt test --browsers Firefox,Safari
rake test[Safari] --> grunt test --browsers Safari
rake autotest --> grunt autotest

NOTES:
* For convenience grunt test:e2e starts a webserver for you, while grunt test:end2end doesn't.
  Use grunt test:end2end if you already have the webserver running.
* Removes duplicate entry for Describe.js in the angularScenario section of angularFiles.js
* Updates docs/src/gen-docs.js to use #done intead of the deprecated #end
* Uses grunt-contrib-connect instead of lib/nodeserver (removed)
* Removes nodeserver.sh, travis now uses grunt webserver
* Built and minified files are identical to Rake's output, with the exception of one less
  character for git revisions (using --short) and a couple minor whitespace differences

Closes #199

											
										
										
											2012-10-21 06:37:59 +00:00
+								    grunt package
 								    grunt test:e2e
-												readme

											
										
										
											2010-03-15 21:41:28 +00:00
-												chore(Grunt): switch from Rake to Grunt

Migrates the Angular project from Rake to Grunt.

Benefits:
- Drops Ruby dependency
- Lowers barrier to entry for contributions from JavaScript ninjas
- Simplifies the Angular project setup and build process
- Adopts industry-standard tools specific to JavaScript projects
- Support building angular.js on Windows platform (really?!? why?!?)

BREAKING CHANGE: Rake is completely replaced by Grunt. Below are the deprecated Rake tasks and their Grunt equivalents:

rake --> grunt
rake package --> grunt package
rake init --> N/A
rake clean --> grunt clean
rake concat_scenario --> grunt build:scenario
rake concat --> grunt build
rake concat_scenario --> grunt build:scenario
rake minify --> grunt minify
rake version --> grunt write:version
rake docs --> grunt docs
rake webserver --> grunt webserver
rake test --> grunt test
rake test:unit --> grunt test:unit
rake test:<jqlite|jquery|modules|e2e> --> grunt test:<jqlite|jquery|modules|end2end|e2e>
rake test[Firefox+Safari] --> grunt test --browsers Firefox,Safari
rake test[Safari] --> grunt test --browsers Safari
rake autotest --> grunt autotest

NOTES:
* For convenience grunt test:e2e starts a webserver for you, while grunt test:end2end doesn't.
  Use grunt test:end2end if you already have the webserver running.
* Removes duplicate entry for Describe.js in the angularScenario section of angularFiles.js
* Updates docs/src/gen-docs.js to use #done intead of the deprecated #end
* Uses grunt-contrib-connect instead of lib/nodeserver (removed)
* Removes nodeserver.sh, travis now uses grunt webserver
* Built and minified files are identical to Rake's output, with the exception of one less
  character for git revisions (using --short) and a couple minor whitespace differences

Closes #199

											
										
										
											2012-10-21 06:37:59 +00:00
+								To learn more about the grunt tasks, run `grunt --help` and also read our
 								[contribution guidelines](http://docs.angularjs.org/misc/contribute).