Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Angular 5 Basic Demo Project Overview

DZone's Guide to

Angular 5 Basic Demo Project Overview

Interested in learning how to use the newest version of Angular? Read on to see how to get your project up and running with this framework!

· Web Dev Zone
Free Resource

Learn how to build modern digital experience apps with Crafter CMS. Download this eBook now. Brought to you in partnership with Crafter Software

Introduction

This post is a continuation of the Angular 5 series and you can find the first part of this series here What Is New and How to Set Up our First Angular 5 Application. So if you haven’t gone through the first part yet, I strongly recommend you to do that. In our first part, we saw the Angular 5 updates and how to set up your first application in Angular 5. In this post, we are going to discuss a few files and give an application overview. We will also be discussing some key points like Components, Declarations, Modules, Providers, etc. So at the end of this article, you will have some basic understanding of Angular project structures and why it really matter when it comes to the project. I hope you will like this article.

Source Code

You can always clone or download the source code here.

Background

Though Angular 5 has exactly the same project architecture as the previous version, we will be explaining some key elements so that the beginners can follow along with this series. I hope you will not mind if you are an experienced professional. Thanks for understanding.

Understanding Angular Applications

The Angular project has a clean architecture, it contains the folder structure as shown in the following image.

Image title

Angular_App_Folder_Structure

We are going to start developing our application in the src/app folder which is our application root folder. For now, let’s go ahead and see what we have got in the existing files. Let us open the file app.component.ts.

import { Component } from '@angular/core';
@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.scss']
})
export class AppComponent {
  title = 'app';
}

In Angular, we are creating components for each selected functionality. Let’s make one component for login, one for the register, one for navigation, etc., so that each can be maintained separately. In each component, we have 3 parts.

  1. Import section.
  2. Decoration.
  3. Export section.

The import section helps us to import some existing functionalities available in the framework, like how we included the Component from Angular/core in the above code snippet.

The Decoration is the place where we decorate the component, giving a selector (which is unique to each component), style the UI, and give the template URL which points to a particular HTML file where we customize the component. We can also include our template in our decoration itself as a template: 'here your custom HTML.'

The Export section includes the custom TypeScript code which is specific to that component. Let’s say it is a class, which holds its own functionalities.

Now let us just move our pointer to app.module.ts, this is the place where we register all of our modules, components, providers, etc. We can consider this as a base class. Like components, it has a section for imports and exports. It also has a @NgModule section, which contains our declarations (components), imports (modules), providers (services).

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

I am not going to talk in too much depth about app.component.css, app.component.html, app.component.spec.ts, as you can see what it has, by seeing the code inside. So I am leaving that to you.

If you see the project folder, you can see a folder named Environment. As the name implies, it helps us to set the configurations for our environments, such as development and production.

Index.html is the main page from which we call the app-root; remember we set the app.component’s selector as app-root?

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>MyAngular5App</title>
  <base href="/">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="icon" type="image/x-icon" href="favicon.ico">
</head>
<body>
  <app-root></app-root>
</body>
</html>

Please make sure that you are giving <base href=”/”> in your index.html file, or else you will get an error in your Angular app.

The tsconfig.app.json file is the place where we can set the configuration for our project, like setting the module versions, compiler options, etc. You can see a sample file as below.

{
  "extends": "../tsconfig.json",
  "compilerOptions": {
    "outDir": "../out-tsc/app",
    "baseUrl": "./",
    "module": "es2015",
    "types": []
  },
  "exclude": [
    "test.ts",
    "**/*.spec.ts"
  ]
}

If you have created your Angular app using the Angular CLI, you will see a file named .angular-cli.json in your project. This is the file where all of your custom project settings reside.

{
  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
  "project": {
    "name": "my-angular5-app"
  },
  "apps": [
    {
      "root": "src",
      "outDir": "dist",
      "assets": [
        "assets",
        "favicon.ico"
      ],
      "index": "index.html",
      "main": "main.ts",
      "polyfills": "polyfills.ts",
      "test": "test.ts",
      "tsconfig": "tsconfig.app.json",
      "testTsconfig": "tsconfig.spec.json",
      "prefix": "app",
      "styles": [
        "styles.css"
      ],
      "scripts": [],
      "environmentSource": "environments/environment.ts",
      "environments": {
        "dev": "environments/environment.ts",
        "prod": "environments/environment.prod.ts"
      }
    }
  ],
  "e2e": {
    "protractor": {
      "config": "./protractor.conf.js"
    }
  },
  "lint": [
    {
      "project": "src/tsconfig.app.json",
      "exclude": "**/node_modules/**"
    },
    {
      "project": "src/tsconfig.spec.json",
      "exclude": "**/node_modules/**"
    },
    {
      "project": "e2e/tsconfig.e2e.json",
      "exclude": "**/node_modules/**"
    }
  ],
  "test": {
    "karma": {
      "config": "./karma.conf.js"
    }
  },
  "defaults": {
    "styleExt": "css",
    "component": {}
  }
}

Last but not the least, package.json is the file where your NPM packages are mentioned, and whenever you run npm install commands, this is the file that command looks into.

{
  "name": "my-angular5-app",
  "version": "0.0.0",
  "license": "MIT",
  "scripts": {
    "ng": "ng",
    "start": "ng serve",
    "build": "ng build",
    "test": "ng test",
    "lint": "ng lint",
    "e2e": "ng e2e"
  },
  "private": true,
  "dependencies": {
    "@angular/animations": "^5.0.0",
    "@angular/common": "^5.0.0",
    "@angular/compiler": "^5.0.0",
    "@angular/core": "^5.0.0",
    "@angular/forms": "^5.0.0",
    "@angular/http": "^5.0.0",
    "@angular/platform-browser": "^5.0.0",
    "@angular/platform-browser-dynamic": "^5.0.0",
    "@angular/router": "^5.0.0",
    "core-js": "^2.4.1",
    "rxjs": "^5.5.2",
    "zone.js": "^0.8.14"
  },
  "devDependencies": {
    "@angular/cli": "1.5.0",
    "@angular/compiler-cli": "^5.0.0",
    "@angular/language-service": "^5.0.0",
    "@types/jasmine": "~2.5.53",
    "@types/jasminewd2": "~2.0.2",
    "@types/node": "~6.0.60",
    "codelyzer": "~3.2.0",
    "jasmine-core": "~2.6.2",
    "jasmine-spec-reporter": "~4.1.0",
    "karma": "~1.7.0",
    "karma-chrome-launcher": "~2.1.1",
    "karma-cli": "~1.0.1",
    "karma-coverage-istanbul-reporter": "^1.2.1",
    "karma-jasmine": "~1.1.0",
    "karma-jasmine-html-reporter": "^0.2.2",
    "protractor": "~5.1.2",
    "ts-node": "~3.2.0",
    "tslint": "~5.7.0",
    "typescript": "~2.4.2"
  }
}

Once the package manager finishes running the install command, all the mentioned packages will be added to the folder node_modules.

In our next article, we will start developing some components in our Angular app. Till then, bye.

Conclusion

Thanks a lot for reading! Did I miss anything that you think is needed? Did you find this post useful? I hope you liked this article. Please share your valuable suggestions and feedback.

Crafter is a modern CMS platform for building modern websites and content-rich digital experiences. Download this eBook now. Brought to you in partnership with Crafter Software.

Topics:
web dev ,angular ,angular 5 ,typescript ,json

Published at DZone with permission of Sibeesh Venu, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}