Angular 2 Getting started with Angular 2 Install angular2 with angular-cli
Example
This example is a quick setup of Angular 2 and how to generate a quick example project.
Prerequisites:
- Node.js v4 or greater.
- npm v3 or greater or yarn.
Open a terminal and run the commands one by one:
npm install -g @angular/cli
or
yarn global add @angular/cli
depending on your choice of package manager.
The previous command installs @angular/cli globally, adding the executable ng to PATH.
To setup a new project
Navigate with the terminal to a folder where you want to set up the new project.
Run the commands:
ng new PROJECT_NAME
cd PROJECT_NAME
ng serve
That is it, you now have a simple example project made with Angular 2. You can now navigate to the link displayed in terminal and see what it is running.
To add to an existing project
Navigate to the root of your current project.
Run the command:
ng init
This will add the necessary scaffolding to your project. The files will be created in the current directory so be sure to run this in an empty directory.
Running The Project Locally
In order to see and interact with your application while it's running in the browser you must start a local development server hosting the files for your project.
ng serve
If the server started successfully it should display an address at which the server is running. Usually is this:
http://localhost:4200
Out of the box this local development server is hooked up with Hot Module Reloading, so any changes to the html, typescript, or css, will trigger the browser to be automatically reloaded (but can be disabled if desired).
Generating Components, Directives, Pipes and Services
The ng generate <scaffold-type> <name> (or simply ng g <scaffold-type> <name>) command allows you to automatically generate Angular components:
# The command below will generate a component in the folder you are currently at
ng generate component my-generated-component
# Using the alias (same outcome as above)
ng g component my-generated-component
There are several possible types of scaffolds angular-cli can generate:
| Scaffold Type | Usage |
|---|---|
| Module | ng g module my-new-module |
| Component | ng g component my-new-component |
| Directive | ng g directive my-new-directive |
| Pipe | ng g pipe my-new-pipe |
| Service | ng g service my-new-service |
| Class | ng g class my-new-class |
| Interface | ng g interface my-new-interface |
| Enum | ng g enum my-new-enum |
You can also replace the type name by its first letter. For example:
ng g m my-new-module to generate a new module or ng g c my-new-component to create a component.
Building/Bundling
When you are all finished building your Angular 2 web app and you would like to install it on a web server like Apache Tomcat, all you need to do is run the build command either with or without the production flag set. Production will minifiy the code and optimize for a production setting.
ng build
or
ng build --prod
Then look in the projects root directory for a /dist folder, which contains the build.
If you'd like the benefits of a smaller production bundle, you can also use Ahead-of-Time template compilation, which removes the template compiler from the final build:
ng build --prod --aot
Unit Testing
Angular 2 provides built-in unit testing, and every item created by angular-cli generates a basic unit test, that can be expanded. The unit tests are written using jasmine, and executed through Karma. In order to start testing execute the following command:
ng test
This command will execute all the tests in the project, and will re-execute them every time a source file changes, whether it is a test or code from the application.
For more info also visit: angular-cli github page
