| 1 | Protractor [](https://travis-ci.org/angular/protractor) [](https://circleci.com/gh/angular/protractor) [](https://gitter.im/angular/protractor)
|
| 2 | ==========
|
| 3 |
|
| 4 | [Protractor](http://angular.github.io/protractor) is an end-to-end test framework for [Angular](http://angular.io/) and [AngularJS](http://angularjs.org) applications. Protractor is a [Node.js](http://nodejs.org/) program built on top of [WebDriverJS](https://github.com/SeleniumHQ/selenium/wiki/WebDriverJs). Protractor runs tests against your application running in a real browser, interacting with it as a user would.
|
| 5 |
|
| 6 | Compatibility
|
| 7 | -------------
|
| 8 |
|
| 9 | Protractor 5 is compatible with nodejs v6 and newer.
|
| 10 |
|
| 11 | Protractor works with AngularJS versions greater than 1.0.6/1.1.4, and is compatible with Angular applications. Note that for Angular apps, the `binding` and `model` locators are not supported. We recommend using `by.css`.
|
| 12 |
|
| 13 |
|
| 14 | Getting Started
|
| 15 | ---------------
|
| 16 | See the [Protractor Website](http://www.protractortest.org) for most documentation.
|
| 17 |
|
| 18 | To get set up and running quickly:
|
| 19 | - Work through the [Tutorial](http://www.protractortest.org/#/tutorial)
|
| 20 | - See the [API](http://www.protractortest.org/#/api)
|
| 21 |
|
| 22 | Once you are familiar with the tutorial, you’re ready to move on. To modify your environment, see the Protractor Setup docs. To start writing tests, see the Protractor Tests docs.
|
| 23 |
|
| 24 | To better understand how Protractor works with the Selenium WebDriver and Selenium Server see the reference materials.
|
| 25 |
|
| 26 |
|
| 27 | Getting Help
|
| 28 | ------------
|
| 29 |
|
| 30 | Check the [Protractor FAQ](https://github.com/angular/protractor/blob/master/docs/faq.md) and read through the [Top 20 questions on StackOverflow](http://stackoverflow.com/questions/tagged/protractor?sort=votes&pageSize=20).
|
| 31 |
|
| 32 | Please ask usage and debugging questions on [StackOverflow](http://stackoverflow.com/questions/tagged/protractor) (use the ["protractor"](http://stackoverflow.com/questions/ask?tags=protractor) tag), the [Gitter](https://gitter.im/angular/protractor) chat room, or in the [Angular discussion group](https://groups.google.com/forum/?fromgroups#!forum/angular). (Please do not ask support questions here on Github.)
|
| 33 |
|
| 34 |
|
| 35 | For Contributors
|
| 36 | ----------------
|
| 37 | See [DEVELOPER.md](https://github.com/angular/protractor/blob/master/DEVELOPER.md)
|