Angular : Angular folder structure

Project Folder Structure

Package.json

This File contains the various packages to build and run our application. It contains two sets of packages, dependencies and devDependencies.

The dependencies are required for running the application.

The devDependencies are only required to develop the application.

These packages are installed into the nodemodules folder by the npm(Node Package Manager).

When npm install command is executed, we can also add our custom scripts here.

node modules

The Packages specified in the package.json file are installed into this folder when we run npm install command.

e2e folder

Contains end-to-end tests and their configuration files.

angular-cli.json

This is the Angular CLI configuration file.

.editorconfig

Configuration file for Visual Studio Code. The settings in this file let you set certain code style guidelines.

For example what indent style do you want -spaces or tabs and what should be the indent size etc. You can share this editorconfig file with other developers to maintain consistent coding styles.

.gitignore

This file is used to determine files and folders you don't want to check in to source control.

For example one of the folders we do not want to check in to source control is /dist folder which is auto generated when we build the application. So this folder is listed in this file. So, all the files and folders listed in this file are ignored, when a change set is checked in to source control..

karma.conf.js

Karma is the unit test runner for angular applications. As the name implies, karma.conf.js is the configuration file for Karma.

protractor.conf.js

Protractor is an end-to-end test framework for Angular applications. As the name implies, protractor.conf.js is the configuration file for Protractor.

README.md

This is a README file which contains the commonly used Angular CLI commands out of the box.

You may enhance it with your own project documentation so that anyone checking out the repo knows the commands to use to build, run and test your app.

tsconfig.json

This is the TypeScript compiler configuration file. This file has several TypeScript compiler configuration settings.

For example, to compile TypeScript to JavaScript on saving a TypeScript file set compileOnSave setting to true. If you do not want .map files to be generated, set sourceMap to false..map files are used for debugging your application.

tslint.json

Angular has a linting tool that checks our TypeScript code for programmatic and stylistic errors as well as non-adherence to coding standards and conventions.

tslint.json is the configuration file for linting.