Anatomy of the Setup Project
The documentation setup procedures install a lot of files. Most of them can be safely ignored.
Application files inside the src/
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.
File | Purpose |
---|---|
src/app/
|
Angular application files go here. Ships with the "Hello Angular" sample's
Try the |
e2e/
|
End-to-end (e2e) tests of the application, written in Jasmine and run by the protractor e2e test runner. Initialized with an e2e test for the "Hello Angular" sample. |
node_modules/
|
The npm packages installed with the |
.editorconfig
|
Tooling configuration files and folders. Ignore them until you have a compelling reason to do otherwise. |
CHANGELOG.md
|
The history of changes to the QuickStart repository. Delete or ignore. |
favicon.ico
|
The application icon that appears in the browser tab. |
index.html
|
The application host page.
It loads a few essential scripts in a prescribed order.
Then it boots the application, placing the root The same |
karma.conf.js
|
Configuration for the karma test runner described in the Testing guide. |
karma-test-shim.js
|
Script to run karma with SystemJS as described in the Testing guide. |
non-essential-files.txt
|
A list of files that you can delete if you want to purge your setup of the original QuickStart Seed testing and git maintenance artifacts. See instructions in the optional Deleting non-essential files section. Do this only in the beginning to avoid accidentally deleting your own tests and git setup! |
LICENSE
|
The open source MIT license to use this setup code in your application. |
package.json
|
Identifies Contains command scripts for running the application,
running tests, and more. Enter |
protractor.config.js
|
Configuration for the protractor end-to-end (e2e) test runner. |
README.md
|
Instruction for using this git repository in your project. Worth reading before deleting. |
styles.css
|
Global styles for the application. Initialized with an |
systemjs
|
Tells the SystemJS module loader where to find modules
referenced in JavaScript
Don't touch this file unless you are fully versed in SystemJS configuration. |
systemjs
|
Optional extra SystemJS configuration.
A way to add SystemJS mappings, such as for application barrels,
without changing the original |
tsconfig.json
|
Tells the TypeScript compiler how to transpile TypeScript source files into JavaScript files that run in all modern browsers. |
tslint.json
|
The This file defines linting rules favored by the Angular style guide and by the authors of the documentation. |