Skip to content

Latest commit

 

History

History
259 lines (197 loc) · 5.78 KB

README.md

File metadata and controls

259 lines (197 loc) · 5.78 KB
Raw

Angular Folder Structure

Highly scalable folder structure for your Angular projects

Save time thinking about your project folder structure and focus on what is important for your clients: finishing the project on time.

Getting started

Fork this repository to start using it.

  1. Install npm packages: npm install
  2. Run ng serve for a dev server
  3. Navigate to http://localhost:4200/
  4. The app will automatically reload if you change any of the source files

Directory tree structure

The app structure was designed to make it easy to maintain web projects.

app/
├── components/
├── directives/
├── guards/
├── models/
├── modules/
├── pages/
├── pipes/
├── services/
└── templates/

Usage

Each folder supports the Angular CLI to quickly generate the files needed.

Components

All components that are not a page or template, should be placed inside the components folder.

app/
├── components/
│   └── example/
│       ├── example.component.html
│       ├── example.component.scss
│       ├── example.component.spec.ts
│       └── example.component.ts
...

Angular CLI command:

ng g component components/COMPONENT_NAME

Directives

Place all directives inside the directives folder.

app/
├── directives/
│   ├── example.directive.spec.ts
│   └── example.directive.ts
...

Angular CLI command:

ng g directive directives/DIRECTIVE_NAME

Guards

Place all guards inside the guards folder.

app/
├── guards/
│   ├── example.guard.spec
│   └── example.guard.ts
...

Angular CLI command:

ng g guard guards/GUARD_NAME

Models

Place all models insite the models folder.

app/
├── models/
│   └── example.guard.ts
...

Angular CLI command:

ng g class models/MODEL_NAME --skipTests=true --type=model

Modules

Place all modules inside the modules folder. Each module should be placed inside its respective folder with the module itself and the routing module.

app/
├── modules/
│   ├── admin/
│   │   ├── admin-routing.module.ts
│   │   └── admin.module.ts
│   ├── dashboard/
│   │   ├── dashboard-routing.module.ts
│   │   └── dashboard.module.ts
│   ├── home/
│   │   ├── home-routing.module.ts
│   │   └── home.module.ts
│   └── site/
│       ├── site-routing.module.ts
│       └── site.module.ts
...

Angular CLI command:

ng g module modules/MODULE_NAME --routing

Pages

Place all pages inside the pages folder. A page is a specific component that represents a site page. Besides that, each page should be inside its respective scope: admin, site.

app/
├── pages/
│   ├── admin/
│   │   └── dashboard/
│   │       ├── dashboard.page.html
│   │       ├── dashboard.page.scss
│   │       ├── dashboard.page.spec.ts
│   │       └── dashboard.page.ts
│   ├── site/
│   │   └── home/
│   │       ├── home.page.html
│   │       ├── home.page.scss
│   │       ├── home.page.spec.ts
│   │       └── home.page.ts
...

Angular CLI command:

ng g component pages/SCOPE/PAGE_NAME --type=page

Pipes

Place all pipes inside the pipes folder.

app/
├── pipes/
│   ├── example.pipe.spec.ts
│   └── example.pipe.ts
...

Angular CLI command:

ng g pipe pipes/PIPE_NAME

Services

Place all services inside the services folder.

app/
├── services/
│   ├── core/
│   │   ├── http-error-handler.service.spec.ts
│   │   └── http-error-handler.service.ts
│   ├── example.service.spec.ts
│   └── example.service.ts
...

Angular CLI command:

ng g service services/SERVICE_NAME

Templates

Place all templates inside the templates folder. A template is a specific component that represents a site template. Besides that, each template should be inside its respective scope: admin, site.

app/
├── templates/
│   ├── admin/
│   │   └── default/
│   │       ├── default.template.html
│   │       ├── default.template.scss
│   │       ├── default.template.spec.ts
│   │       └── default.template.ts
│   └── site/
│   │   └── default/
│   │       ├── default.template.html
│   │       ├── default.template.scss
│   │       ├── default.template.spec.ts
│   │       └── default.template.ts
...

Angular CLI command:

ng g component templates/SCOPE/TEMPLATE_NAME --type=template

Developing

This project uses commitlint to check if the commits messages meet the Conventional Commits.

The commit message pattern:

type(scope?): subject  #scope is optional

Types list:

  • feat: Adds a new feature
  • fix: Solves a bug
  • chore: Other changes that don't modify src or test files
  • docs: Adds or alters documentation
  • style: Improves formatting, white-space
  • refactor: Rewrites code without feature, performance or bug changes
  • perf: Improves performance
  • test: Adds or modifies tests
  • build: Affects the build system or external dependencies
  • ci: Changes CI configuration files and scripts
  • revert: Reverts a previous commit

Licensing

The code in this project is licensed under MIT license.