Andreas/ngx-admin
1
0
Fork 0
mirror of https://github.com/akveo/ngx-admin.git synced 2025-12-26 20:28:48 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update docs for 1.0.0 (#1034)

Browse source
This commit is contained in:
Lex Zhukov 2017-04-28 15:31:26 +03:00 • committed by Alexander Zhukov
parent 6e89e797a8
commit 72ab016e75
13 changed files with 107 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

86
docs/contents/articles/012-project-structure/index.md
View file

@ -6,70 +6,66 @@ group: Customization
template: article.jade
---
The project structure is originally based on [Angular2 Webpack Starter](https://github.com/AngularClass/angular2-webpack-starter#file-structure). We made some changes we thought would be better in our particular case.
The directory structure of this template is as follows:
```
ng2-admin/
├──config/ * webpack build configuration
│ ├──head-config.common.js * configuration for head elements in index.html
├──e2e/
│ ├──tsconfig.e2e.json * typescript config that protractor use for e2e tests
│
├──src/ * source files that will be compiled to javascript
│ ├──typings.d.ts * custom typings for third-party modules
│ │
│ ├──helpers.js * helper functions for our configuration files
│ ├──index.html * application layout
│ │
│ ├──webpack.dev.js * development webpack config
│ ├──main.ts * entry file for our browser environment
│ │
│ ├──webpack.prod.js * production webpack config
│ ├──polyfills.ts * polyfills file
│ │
│ ├──webpack.test.js * testing webpack config
│ │
│ ├──electron/ * electron webpack config
│ │
│ └──html-elements-plugin/ * html elements plugin
│
├──src/ * source files that will be compiled to javascript
│ ├──custom-typings.d.ts * custom typings for third-party modules
│ │
│ ├──desktop.ts * electron window initialization
│ │
│ ├──index.html * application layout
│ │
│ ├──main.browser.ts * entry file for our browser environment
│ │
│ ├──package.json * electrons package.json
│ │
│ ├──polyfills.browser.ts * polyfills file
│ │
│ ├──vendor.browser.ts * vendors file
│ │
│ ├──app/ * application code - our working directory
│ ├──app/ * application code - our working directory
│ │ ├──pages/
│ │ │ ├──pages.menu.ts * menu pages routes
│ │ │
│ │ ├──app.component.ts * main application component
│ │ ├──app.component.ts * main application component
│ │ │
│ │ ├──app.module.ts * main application module
│ │ │
│ │ ├──app.menu.ts * menu pages routes
│ │ │
│ │ ├──app.module.ts * main application module
│ │ │
│ │ ├──app.routes.ts * application routes
│ │ ├──app.routing.ts * application routes
│ │ │
│ │ ├──app.translation.module.ts * main translation module
│ │ │
│ │ ├──global.state.ts * global application state for data exchange between components
│ │ ├──global.state.ts * global application state for data exchange between components
│ │ │
│ │ ├──environment.ts * environment provider
│ │ ├──environment.ts * environment provider
│ │ │
│ │ ├──app.scss * application styles
│ │ ├──app.component.scss * application styles
│ │ │
│ │ ├──pages/ * application pages components, place where you can create pages and fill them with components
│ │ ├──pages/ * application pages components, place where you can create pages and fill them with components
│ │ │
│ │ └──theme/ * template global components/directives/pipes and styles
│ │ └──theme/ * template global components/directives/pipes and styles
│ │
│ └──assets/ * static assets are served here
│ └──assets/ * static assets are served here
│
│
├──tslint.json * typescript lint config
├──typedoc.json * typescript documentation generator
├──tsconfig.json * config that webpack uses for typescript
└──package.json * what npm uses to manage it's dependencies
├──.angular-cli.json * Angular CLI config
│
├──Dockerfile * Docker config
│
├──karma.conf.js * config that karma use for unit tests
│
├──protractor.conf.js * config that protractor use for e2e tests
│
├──.angular-cli.json * Angular CLI config
│
├──.stylelintrc.json * SASS/CSS lint config
│
├──tslint.json * typescript lint config
│
├──typedoc.json * typescript documentation generator
│
├──tsconfig.json * config that webpack uses for typescript
│
└──package.json * what npm uses to manage it's dependencies
```
In our template we tried to separate the theme layer and presentation layer. We believe most of other templates
have them combined. That's why when you start developing using them, it gets very hard for you to remove things you