diff options
Diffstat (limited to 'docs/tutorial_intro.ngdoc')
| -rw-r--r-- | docs/tutorial_intro.ngdoc | 155 |
1 files changed, 0 insertions, 155 deletions
diff --git a/docs/tutorial_intro.ngdoc b/docs/tutorial_intro.ngdoc deleted file mode 100644 index 855f545c..00000000 --- a/docs/tutorial_intro.ngdoc +++ /dev/null @@ -1,155 +0,0 @@ -@workInProgress -@ngdoc overview -@name Intro to Tutorial -@description - -A great way to get introduced to angular is to work through the {@link Tutorial angular tutorial}, -which walks you through the construction of an angular web app. The app you will build in the -tutorial is based on the {@link http://www.google.com/phone/# Google phone gallery app}. - -Once you set up your tutorial environment, you should be able to get through the material in less -than a day and you'll have fun doing it. More experienced coders may be able to zip through the -exercises in an afternoon. In any case, we promise that your time will be well spent! - -When you finish the tutorial you will be able to: - -* Create a simple dynamic application that works in any browser -* Define the differences between angular and common JavaScript frameworks -* Understand angular expressions -* Understand how data binding works in angular -* Create your own angular widgets and directives -* Add your own tags to angular -* Use the angular-seed project to quickly boot-strap your own projects -* Create and run tests -* Identify resources for learning more about angular - -You can work through the tutorial in any of the following ways: - -* <a href="#UsingGit">Using Git</a>. Use the Git Versioning System to get the files for each step. -* <a href="#UsingSnapshots">Using Snapshots</a>. Download snapshots (files for each step of the -tutorial) from the angular server. -* <a href="#ReadingExamples">Reading the Examples</a>. Read through the examples, and inspect -results and code on our server. - -The first two ways (Git and snapshots) give you a fuller experience, in that you can run the unit -and end-to-end tests in addition to the tutorial app. They also give you the ability to play -around with the code and get instant feedback in your browser. The last way (reading through the -tutorial online) requires no setup on your machine, but you can't run the tests, and it won't be -as easy to play around with the code. - -<a name="PreReqs"></a> -# Prerequisites for Git and Snapshots - -To run the tutorial app and tests on your machine (using Git or the snapshots) you will need the -following: - -* An http server running on your system. If you don't already have one installed, you can install -`node.js` ({@link https://github.com/joyent/node/wiki/Installation node.js install}) or another -http sever (such as Apache, etc.). -* Java. This is required for running tests. Angular itself doesn't require Java. -* A modern browser. Needed for viewing and debugging code. -* A text editor of your choice. - -<a name="UsingGit"></a> -# Using Git - -The following instructions are for developers who are comfortable with Git's versioning system: - -1. Check to be sure you have all of the <a href="#PreReqs">prerequisites</a> on your system. - -1. Clone the angular-phonecat repository located at {@link -https://github.com/angular/angular-phonecat angular-phonecat} by running the following command in -a terminal: - - git clone git://github.com/angular/angular-phonecat.git - - This will create a directory called `angular-phonecat`. - -1. In terminal, navigate to the `angular-phonecat` directory and run: - - git checkout step-0 - - (You can run `git checkout step-[0-11]` to go to any of the steps in the tutorial). - -1. To see the app running in your browser, do the following: - * __For node.js users:__ - 1. Run `./scripts/web-server.js` to start the web server. - 1. Open a browser window for the app and navigate to http://localhost:8000/app/index.html. - 1. Open a browser window for the tests, navigate to http://localhost:9876, and choose - "strict mode". - - * __For other http servers:__ - 1. Configure the server to serve the files in the `angular-phonecat` directory. - 1. Start the server. - 1. Navigate in your browser to - http://localhost:[*port-number*]/[*context-path*]/app/index.html. - 1. Navigate in your browser to http://localhost:[*port-number*]/, and choose "strict mode". - -<a name="UsingSnapshots"></a> -# Using Snapshots - -Snapshots are the sets of files that reflect the state of the tutorial app at each step. These -files include the HTML, CSS, and JavaScript for the app, plus Jasmine JavaScript files and Java -libraries for the test stack. These will let you run the tutorial app and tests, without requiring -knowledge of Git. You can download and install the snapshot files as follows: - -1. Check to be sure you have all of the <a href="#PreReqs">prerequisites</a> on your system. - -1. Navigate to [*the angular server*]. - -1. Download and unzip [*the snapshot file*] to a suitable location. - -1. Change directories to [*install-dir*]/sandbox. - -1. Run the following command: - * `./goto_step.sh 0` - - You have to start out at the beginning, which is Step 0. After you set up Step 0, you can skip - around between any steps. - -1. To see the app running in your browser, do the following: - * __For node.js users:__ - 1. Run `./scripts/web-server.js` to run the web server. - 1. Open a browser window for the app and navigate to http://localhost:8000/app/index.html. - 1. Open a browser window for the tests, navigate to http://localhost:9876, and choose - "strict mode". - - * __For other http servers:__ - 1. Configure servers to serve the app and test files in the [*install-dir*]/sandbox. - 1. Start the server. - 1. Navigate in your app browser to - http://localhost:[*port-number*]/[*context-path*]/app/index.html. - 1. Navigate in your test browser to http://localhost:[*port-number*] and choose "strict - mode". - -1. To view the tutorial app at different steps, run `./goto_step.sh [0-11]` and then refresh your -browser. For example, say you're on Step 5 of the tutorial, and you want to see the app in action: - - 1. Run `goto_step.sh 5` from the command line in the `sandbox` directory. - 1. Refresh your app browser. - -<a name="ReadingExamples"></a> -# Reading the Examples - -If you don't want to set up anything on your local machine, you can read through {@link Tutorial -the tutorial} and inspect the tutorial files on our servers; doing this will give you a good idea -of what angular does. - -To see the running app at each tutorial step, click the "Example" link at the top or bottom of -each tutorial page. - -To view the code differences between tutorial steps, click the Code Diff link at top or bottom of -each tutorial page. Additions are highlighted in green; deletions are highlighted in red. - - -# Relative URLs -Throughout the tutorial, we use relative URLs to refer to files hosted on our local http server. -The absolute URL depends on your configuration. For example, if you are using the node.js server, -`app/index.html` translates to: - - http://localhost:8000/app/index.html - -If you are using your own http server running on port 8080 and the tutorial files are hosted at -`/angular_tutorial`, `app/index.html` translates to: - - http://localhost:8080/angular_tutorial/app/index.html |