block includes
include ../_util-fns
:marked
The documentation [setup](setup.html) procedures install a _lot_ of files,
Most of them can be safely ignored.
Application files _inside the_ **`app/`** and **`e2e/`** folders matter most to developers.
Files _outside_ those folders condition the development environment.
They rarely change and you may never view or modify them.
If you do, this page can help you understand their purpose.
style td, th {vertical-align: top}
table(width="100%")
col(width="10%")
col(width="90%")
tr
th File
th Purpose
tr
td app/...
td
:marked
Your Angular application files.
Ships with the "Hello Angular" sample's
`AppComponent`, `AppModule`, a component unit test (`app.component.spec.ts`), and
the bootstrap file, `main.ts`.
tr
td e2e/...
td
:marked
_End-to-end_ (e2e) tests of your application,
written in Jasmine and run by the
protractor
e2e test runner.
Initialized with an e2e test for the "Hello Angular" sample.
tr
td node_modules/...
td
:marked
The _npm_ packages installed with the `npm install` command.
tr
td
code.
.editorconfig
.git/...
.gitignore
.travis.yml
td
:marked
Tooling configuration files and folders.
Ignore them until you have a compelling reason to do otherwise.
tr
td CHANGELOG.md
td
:marked
The history of changes to the _QuickStart_ repository.
Delete or ignore.
tr
td favicon.ico
td
:marked
The application icon that appears in the browser tab.
tr
td index.html
td
:marked
The application host page.
It loads a few essential scripts in a prescribed order.
Then it boots the application, placing the root `AppComponent`
in the custom `` body tag.
The same `index.html` satisfies all documentation application samples.
tr
td karma.conf.js
td
:marked
Configuration for the karma
test runner described in the [Testing](testing.html) guide.
tr
td karma-test-shim.js
td
:marked
Script to run karma
with SystemJS as described in the [Testing](testing.html) guide.
tr
td LICENSE
td
:marked
The open source MIT license to use this setup code in your application.
tr
td package.json
td
:marked
Identifies `npm `package dependencies for the project.
Contains command scripts for running the application,
running tests, and more. Enter `npm run` for a listing.
Read more about them.
tr
td protractor.config.js
td
:marked
Configuration for the
protractor
_end-to-end_ (e2e) test runner.
tr
td README.md
td
:marked
Instruction for using this git repository in your project.
Worth reading before deleting.
tr
td styles.css
td
:marked
Global styles for the application. Initialized with an `` style for the QuickStart demo.
tr
td systemjs
.config.js
td
:marked
Tells the **SystemJS** module loader where to find modules
referenced in JavaScript `import` statements such as
code-example(language="ts").
import { Component } from '@angular/core;
:marked
Don't touch this file unless you are fully versed in SystemJS configuration.
tr
td systemjs
.config.extras.js
td
:marked
Optional extra SystemJS configuration.
A way to add SystemJS mappings, such as for appliation _barrels_,
without changing the original `system.config.js`.
tr
td tsconfig.json
td
:marked
Tells the TypeScript compiler how to transpile TypeScript source files
into JavaScript files that run in all modern browsers.
tr
td tslint.json
td
:marked
The `npm` installed TypeScript linter inspects your TypeScript code
and complains when you violate one of its rules.
This file defines linting rules favored by the
[Angular style guide](style-guide.html) and by the authors of the documentation.