See It Run!
Clicking that link fires up a browser, loads the sample in plunker, and displays a simple message:
Here is the file structure:
Functionally, it's an
We can handle that!
Of course we won't build many apps that only run in plunker. Let's follow a process that's closer to what we'd do in real life.
- Set up our development environment
- Write the Angular root component for our app
- Add an Angular Module
- Bootstrap it to take control of the main web page
- Write the main page (
- Add some CSS (
We really can build the QuickStart from scratch in five minutes if we follow the instructions and ignore the commentary.
Most of us will be interested in the "why" as well as the "how" and that will take longer.
We'll need a place to stand (the application project folder), some libraries and your editor of choice.
Create a new project folder
Add the libraries we need
We recommend the npm package manager for acquiring and managing our development libraries.
Don't have npm? Get it now because we're going to use it now and repeatedly throughout this documentation.
Add a package.json file to the project folder and copy/paste the following:
Itching to know the details? We explain in the appendix below
Install these packages by opening a terminal window (command window in Windows) and running this npm command.
Scary error messages in red may appear during install. Ignore them. The install will succeed. See the appendix below for more information.
Our First Angular Component
The Component is the most fundamental of Angular concepts. A component manages a view - a piece of the web page where we display information to the user and respond to user feedback.
Technically, a component is a class that controls a view template. We'll write a lot of them as we build Angular apps. This is our first attempt so we'll keep it ridiculously simple.
Create an application source sub-folder
We like to keep our application code in a sub-folder off the root called
Execute the following command in the console window.
Add the component file
Now add a file named app.component.js and paste the following lines:
We're creating a visual component named
AppComponent by chaining the
Class methods that belong to the global Angular core namespace,
Component method takes a configuration object with three
Class method is where we implement the component itself,
giving it properties and methods that bind to the view and whatever
behavior is appropriate for this part of the UI.
Let's review this file in detail.
Angular apps are modular. They consist of many files each dedicated to a purpose.
We'll call it
app and we'll add all of our code artifacts to this one global object.
We don't want to pollute the global namespace with anything else. So within each file we surround the code in an IIFE ("Immediately Invoked Function Expression").
We pass the global
app namespace object into the IIFE,
taking care to initialize it with an empty object if it doesn't yet exist.
Most application files export one thing by adding that thing to the
app.component.js file exports the
A more sophisticated application would have child components that descended from
AppComponent in a visual tree.
A more sophisticated app would have more files and modules, at least as many as it had components.
Quickstart isn't sophisticated; one component is all we need. Yet modules play a fundamental organizational role in even this small app.
provided by another module, we get it from the
When another module needs to refer to
AppComponent, it gets it from the
app.AppComponent like this:
Angular is also modular. It is a collection of library modules. Each library is itself a module made up of several, related feature modules.
When we need something from Angular, we use the
The Class definition object
At the bottom of the file is an empty, do-nothing class definition object for
When we're ready to build a substantive application,
we can expand this object with properties and application logic.
AppComponent class has nothing but an empty constructor because we
don't need it to do anything in this QuickStart.
The Component definition object
ng.core.Component() tells Angular that this class definition object
is an Angular component.
The configuration object passed to the
ng.core.Component() method has two
selector and a
selector specifies a simple CSS selector for a host HTML element named
Angular creates and displays an instance of our
wherever it encounters a
my-app element in the host HTML.
my-app selector! We'll need that information when we write our
template property holds the component's companion template.
A template is a form of HTML that tells Angular how to render a view.
Our template is a single line of HTML announcing "Hello Angular".
Now we need something to tell Angular to load this component.
Add an NgModule
Angular apps are composed of Angular Modules that snuggly contain all our components and everything else we need for our app.
src/app/app.module.js file with the following content:
Read more about the
NgModule configuration in the appendix below.
Add a new file ,
main.js, to the
src/app/ folder as follows:
We need two things to launch the application:
- The application root module that we just wrote.
We have them both in our 'namespaces'.
Then we call
bootstrapModule, passing in the root app module,
Learn why we need
and why we create a separate js files in the appendix below.
We've asked Angular to launch the app in a browser with our component at the root. Where will Angular put it?
Angular displays our application in a specific location on our
It's time to create that file.
We won't put our
index.html in the
We'll locate it up one level, in the project root folder.
Now create the
index.html file and paste the following lines:
There are three noteworthy sections of HTML:
We add the
<my-app>tag in the
<body>. This is where our app lives!
When Angular calls the
bootstrapModule function in
it reads the
AppModule metadata, sees that
AppComponent is the bootstrap component,
my-app selector, locates an element tag named
and renders our application's view between those tags.
Add some style
Styles aren't essential but they're nice, and
index.html assumes we have
a stylesheet called
styles.css file in the project root folder and start styling, perhaps with the minimal
styles shown below. For the full set of master styles used by the documentation samples,
Configure the server
We're going to use a static server called lite-server that loads
index.html in a browser
and refreshes the browser when application files change.
The static server will use the
bs-config.json file as configuration.
This files tells the server that
src/ is the base directory to serve, and that any
node_modules/ should be routed to
node_modules/ in the root directory
Open a terminal window and enter this command:
That command runs lite-server.
In a few moments, a browser tab should open and display
Congratulations! We are in business.
If you see
Loading... displayed instead, see the
Browser ES2015 support appendix.
Make some changes
Try changing the message to "Hello Angular!".
lite-server is watching, so it should detect the change,
refresh the browser, and display the revised message.
It's a nifty way to develop an application!
We close the terminal window when we're done to terminate the server.
Our final project folder structure looks like this:
And here are the files:
Our first application doesn't do much. It's basically "Hello, World" for Angular.
We kept it simple in our first pass: we wrote a little Angular component,
index.html, and launched with a
static file server. That's about all we'd expect to do for a "Hello, World" app.
We have greater ambitions.
The good news is that the overhead of setup is (mostly) behind us.
We'll probably only touch the
package.json to update libraries.
Besides adding in the script files for our app 'modules',
we'll likely open
index.html only if we need to add a library or some css stylesheets.
We're about to take the next step and build a small application that demonstrates the great things we can build with Angular.
Join us on the Tour of Heroes Tutorial!
The balance of this chapter is a set of appendices that elaborate some of the points we covered quickly above.
There is no essential material here. Continued reading is for the curious.
We loaded the following scripts
We began with an Internet Explorer polyfill. IE requires a polyfill to run an application that relies on ES2015 promises and dynamic module loading. Most applications need those capabilities and most applications should run in Internet Explorer.
Next are the polyfills for Angular,
followed by the Reactive Extensions RxJS library.
Our QuickStart doesn't use the Reactive Extensions but any substantial application will want them when working with observables. We added the library here in QuickStart so we don't forget later.
Finally, we loaded the web development version of Angular itself.
We'll make different choices as we gain experience and become more concerned about production qualities such as load times and memory footprint.
npm is a popular package manager and Angular application developers rely on it to acquire and manage the libraries their apps require.
We specify the packages we need in an npm package.json file.
The Angular team suggests the packages listed in the
sections listed in this file:
There are other possible package choices. We're recommending this particular set that we know work well together. Play along with us for now. Feel free to make substitutions later to suit your tastes and experience.
package.json has an optional scripts section where we can define helpful
commands to perform development and build tasks.
We've included a number of such scripts in our suggested
We've seen how we can run the server with this command:
We are using the special
npm start command, but all it does is run
npm run lite.
We execute npm scripts in that manner:
npm run + script-name. Here's what these scripts do:
npm run lite- run the lite-server, a light-weight, static file server, written and maintained by John Papa with excellent support for Angular apps that use routing.
Appendix: npm errors and warnings
All is well if there are no console messages starting with
npm ERR! at the end of npm install.
There might be a few
npm WARN messages along the way — and that is perfectly fine.
We often see an
npm WARN message after a series of
gyp ERR! messages.
Ignore them. A package may try to re-compile itself using
If the re-compile fails, the package recovers (typically with a pre-built version)
and everything works.
Just make sure there are no
npm ERR! messages at the very end of
NgModule decorator is listing:
- What other Angular Modules ours uses
- Which components and directives we declare in our components
- The component to bootstrap at the start
We import our lone
app.AppComponent and add it to both
Notice that we also add
ng.platformBrowser.BrowserModule to the
This is the Angular Module that contains all the needed Angular bits and pieces to run our app in the browser.
Angular itself is split into separate Angular Modules so we only need to import the ones we really use.
One of the most common ones is
FormsModule, and soon we'll also see
Bootstrapping is platform-specific
We use the
platformBrowserDynamic().bootstrapModule function from
ng.core. There's a good reason.
We only call "core" those capabilities that are the same across all platform targets. True, most Angular applications run only in a browser and we'll call the bootstrap function from this library most of the time. It's pretty "core" if we're always writing for a browser.
But it is possible to load a component in a different environment. We might load it on a mobile device with Apache Cordova or NativeScript. We might wish to render the first page of our application on the server to improve launch performance or facilitate SEO.
These targets require a different kind of bootstrap function that we'd import from a different library.
Why do we create a separate main.js, app.module.js and app.component.js files?
The main.js file is tiny. This is just a QuickStart.
We could have folded its few lines into the
app.module.js file, and that one into
app.component.js and spared ourselves some complexity.
We didn't for what we believe to be good reasons:
- Doing it right is easy
- Separation of concerns
- We learned about import and export
Sure it's an extra step and an extra file. How hard is that in the scheme of things?
We'll see that a separate
app.module.js is beneficial for most apps
even if it isn't critical for the QuickStart.
Let's develop good habits now while the cost is low.
We should be thinking about testability from the beginning even if we know we'll never test the QuickStart.
It is difficult to unit test a component when there is a call to
bootstrapModule in the same file.
As soon as we load the component file to test the component,
bootstrapModule function tries to load the application in the browser.
It throws an error because we're not expecting to run the entire application,
just test the component.
bootstrapModule function to
main.js eliminates this spurious error
and leaves us with a clean component module file.
We refactor, rename, and relocate files as our application evolves.
We can't do any of those things while the file calls
we can't move it.
We can't reuse the component in another application.
We can't pre-render the component on the server for better performance.
Separation of concerns
A component's responsibility is to present and manage a view, and a NgModule's reponsibility is to define the application context.
Launching the application has nothing to do with any of these. That's a separate concern. The friction we're encountering in testing and reuse stems from this unnecessary mix of responsibilities.
While writing a separate
app.module.js files we learned an essential Angular skill:
how to 'export' from one 'module' and 'import' into another via our simple
We'll do a lot of that as we learn more Angular.