8.5 KiB

Raw Blame History

Setup for upgrading from AngularJS

Audience: Use this guide only in the context of Upgrading from AngularJS or Upgrading for Performance. Those Upgrade guides refer to this Setup guide for information about using the deprecated QuickStart GitHub repository, which was created prior to the current Angular CLI.

For all other scenarios, see the current instructions in Setting up the Local Environment and Workspace.

This guide describes how to develop locally on your own machine. Setting up a new project on your machine is quick and easy with the QuickStart seed on github.

Prerequisite: Make sure you have Node.js® and npm installed.

{@a clone}

Clone

Perform the clone-to-launch steps with these terminal commands.

git clone https://github.com/angular/quickstart.git quickstart cd quickstart npm install npm start

npm start fails in Bash for Windows in versions earlier than the Creator's Update (April 2017).

{@a download}

Download

Download the QuickStart seed and unzip it into your project folder. Then perform the remaining steps with these terminal commands.

cd quickstart npm install npm start

npm start fails in Bash for Windows in versions earlier than the Creator's Update (April 2017).

{@a non-essential}

Delete non-essential files (optional)

You can quickly delete the non-essential files that concern testing and QuickStart repository maintenance (including all git-related artifacts such as the .git folder and .gitignore!).

Do this only in the beginning to avoid accidentally deleting your own tests and git setup!

Open a terminal window in the project folder and enter the following commands for your environment:

OS/X (bash)

xargs rm -rf < non-essential-files.osx.txt rm src/app/*.spec*.ts rm non-essential-files.osx.txt

Windows

for /f %i in (non-essential-files.txt) do del %i /F /S /Q rd .git /s /q rd e2e /s /q

{@a seed}

What's in the QuickStart seed?

The QuickStart seed provides a basic QuickStart playground application and other files necessary for local development. Consequently, there are many files in the project folder on your machine, most of which you can learn about later.

Reminder: The "QuickStart seed" example was created prior to the Angular CLI, so there are some differences between what is described here and an Angular CLI application.

{@a app-files}

Focus on the following three TypeScript (.ts) files in the /src folder.

src

<div class='file'>
  app
</div>

<div class='children'>

  <div class='file'>
    app.component.ts
  </div>

  <div class='file'>
    app.module.ts
  </div>

</div>

<div class='file'>
  main.ts
</div>

All guides and cookbooks have at least these core files. Each file has a distinct purpose and evolves independently as the application grows.

Files outside src/ concern building, deploying, and testing your app. They include configuration files and external dependencies.

Files inside src/ "belong" to your app. Add new Typescript, HTML and CSS files inside the src/ directory, most of them inside src/app, unless told to do otherwise.

The following are all in src/

<th>
  File
</th>

<th>
  Purpose
</th>

<td>
  <code>app/app.component.ts</code>
</td>

<td>


  Defines the same `AppComponent` as the one in the QuickStart playground.
  It is the **root** component of what will become a tree of nested components
  as the application evolves.
</td>

<td>
  <code>app/app.module.ts</code>
</td>

<td>


  Defines `AppModule`, the  [root module](guide/bootstrapping "AppModule: the root module") that tells Angular how to assemble the application.
  When initially created, it declares only the `AppComponent`.
  Over time, you add more components to declare.
</td>

<td>
  <code>main.ts</code>
</td>

<td>


  Compiles the application with the [JIT compiler](guide/glossary#jit) and
  [bootstraps](guide/bootstrapping)
  the application's main module (`AppModule`) to run in the browser.
  The JIT compiler is a reasonable choice during the development of most projects and
  it's the only viable choice for a sample running in a _live-coding_ environment such as Stackblitz.
  Alternative [compilation](guide/aot-compiler), [build](guide/build), and [deployment](guide/deployment) options are available.

</td>

Appendix: Develop locally with IE

If you develop Angular locally with ng serve, a websocket connection is set up automatically between browser and local dev server, so when your code changes, the browser can automatically refresh.

In Windows, by default, one application can only have 6 websocket connections, MSDN WebSocket Settings. So when IE is refreshed (manually or automatically by ng serve), sometimes the websocket does not close properly. When websocket connections exceed the limitations, a SecurityError will be thrown. This error will not affect the Angular application, you can just restart IE to clear this error, or modify the windows registry to update the limitations.

Appendix: Test using `fakeAsync()/waitForAsync()`

If you use the fakeAsync()/waitForAsync() helper function to run unit tests (for details, read the Testing guide), you need to import zone.js/testing in your test setup file.

If you create project with `Angular/CLI`, it is already imported in `src/test.ts`.

And in the earlier versions of Angular, the following files were imported or added in your html file:

import 'zone.js/plugins/long-stack-trace-zone';
import 'zone.js/plugins/proxy';
import 'zone.js/plugins/sync-test';
import 'zone.js/plugins/jasmine-patch';
import 'zone.js/plugins/async-test';
import 'zone.js/plugins/fake-async-test';

You can still load those files separately, but the order is important, you must import proxy before sync-test, async-test, fake-async-test and jasmine-patch. And you also need to import sync-test before jasmine-patch, so it is recommended to just import zone-testing instead of loading those separated files.

8.5 KiB Raw Blame History