ngx-admin/articles/012-project-structure/index.html

123 lines
6.5 KiB
HTML
Raw Normal View History

2016-05-25 13:42:47 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width">
<meta name="keywords" content="admin,dashboard,template,angular,bootstrap,blur,panel,html,css,javascript">
2016-07-12 16:34:59 +03:00
<title>ng2-admin documentation - Project Structure</title>
2016-05-25 13:42:47 +03:00
<link rel="alternate" href="http://localhost:8080/feed.xml" type="application/rss+xml" title="">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900italic,900|Anonymous+Pro:400,700,400italic,700italic&amp;subset=latin,greek,greek-ext,vietnamese,cyrillic-ext,latin-ext,cyrillic">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.min.css">
<link rel="stylesheet" href="/ng2-admin/css/main.css">
<link rel="shortcut icon" href="/ng2-admin/images/favicon.png">
</head>
<body>
<div class="container">
<div class="nav-main">
<div class="wrap"><a href="/ng2-admin/" class="nav-home"><img src="/ng2-admin/images/logo.png" width="24" height="24" class="nav-logo">&nbsp;<span class="blur-label">ng2-</span>admin</a>
<ul class="nav-site nav-site-internal">
<li><a href="/ng2-admin/">Home</a></li>
<li><a href="/ng2-admin/articles/001-getting-started/" class="active">Docs</a></li>
</ul><span class="nav-docs-right">Need some help? Let us know! <a href="mailto:contact@akveo.com">contact@akveo.com</a></span>
</div>
</div>
<section class="content wrap documentationContent">
<div class="nav-docs">
<div class="nav-docs section">
2016-07-28 17:26:09 +03:00
<h5>Quick Start</h5>
2016-05-25 13:42:47 +03:00
<ul>
<li><a href="/ng2-admin/articles/001-getting-started/">Getting Started</a></li>
<li><a href="/ng2-admin/articles/002-installation-guidelines/">Installation Guidelines</a></li>
</ul>
</div>
<div class="nav-docs section">
2016-07-28 17:26:09 +03:00
<h5>Customization</h5>
2016-05-25 13:42:47 +03:00
<ul>
<li><a href="/ng2-admin/articles/011-changing-color-scheme/">Changing Color Scheme</a></li>
<li><a href="/ng2-admin/articles/014-switch-to-blur-theme/">Enabling blur theme</a></li>
<li><a href="/ng2-admin/articles/012-project-structure/" class="active">Project Structure</a></li>
<li><a href="/ng2-admin/articles/013-create-new-page/">Create New Page</a></li>
</ul>
</div>
<div class="nav-docs section">
2016-07-28 17:26:09 +03:00
<h5>Components</h5>
2016-05-25 13:42:47 +03:00
<ul>
<li><a href="/ng2-admin/articles/016-spinner/">Theme Spinner</a></li>
<li><a href="/ng2-admin/articles/015-sidebar/">Sidebar</a></li>
</ul>
</div>
</div>
<div class="inner-content">
<h1>Project Structure</h1>
2017-04-28 16:56:56 +03:00
<div class="subHeader"></div><p>The directory structure of this template is as<span class="widont">&nbsp;</span>follows:</p>
2016-05-25 13:42:47 +03:00
<pre><code>ng2-admin/
2017-04-28 16:56:56 +03:00
├──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
2016-10-13 16:27:42 +03:00
│ │
2017-04-28 16:56:56 +03:00
│ ├──index.html * application layout
2016-10-13 16:27:42 +03:00
│ │
2017-04-28 16:56:56 +03:00
│ ├──main.ts * entry file for our browser environment
2016-10-13 16:27:42 +03:00
│ │
2017-04-28 16:56:56 +03:00
│ ├──polyfills.ts * polyfills file
2016-10-13 16:27:42 +03:00
│ │
2017-04-28 16:56:56 +03:00
│ ├──app/ * application code - our working directory
│ │ ├──pages/
│ │ │ ├──pages.menu.ts * menu pages routes
2016-05-25 13:42:47 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ ├──app.component.ts * main application component
2016-05-25 13:42:47 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ ├──app.module.ts * main application module
2016-10-13 16:27:42 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ ├──app.routing.ts * application routes
│ │ │
│ │ ├──app.translation.module.ts * main translation module
2016-10-13 16:27:42 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ ├──global.state.ts * global application state for data exchange between components
2016-05-25 13:42:47 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ ├──environment.ts * environment provider
2016-05-25 13:42:47 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ ├──app.component.scss * application styles
2016-05-25 13:42:47 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ ├──pages/ * application pages components, place where you can create pages and fill them with components
2016-05-25 13:42:47 +03:00
│ │ │
2017-04-28 16:56:56 +03:00
│ │ └──theme/ * template global components/directives/pipes and styles
2016-05-25 13:42:47 +03:00
│ │
2017-04-28 16:56:56 +03:00
│ └──assets/ * static assets are served here
├──.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
2016-05-25 13:42:47 +03:00
2017-04-28 16:56:56 +03:00
├──tsconfig.json * config that webpack uses for typescript
2016-05-25 13:42:47 +03:00
2017-04-28 16:56:56 +03:00
└──package.json * what npm uses to manage it&#39;s dependencies
2016-09-20 11:36:39 +03:00
</code></pre><p>In our template we tried to separate the theme layer and presentation layer. We believe most of other templates
have them combined. Thats why when you start developing using them, it gets very hard for you to remove things you
2017-02-28 14:37:20 +03:00
dont<span class="widont">&nbsp;</span>need.</p>
2016-05-25 13:42:47 +03:00
</div>
</section>
<footer class="wrap">
2017-04-28 16:56:56 +03:00
<div class="left">Powered by Angular, Bootstrap 4, Angular CLI and many more...</div>
<div class="right">© 2017 Akveo LLC<br />Documentation licensed under <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>.</div>
2016-05-25 13:42:47 +03:00
</footer>
</div><a href="https://github.com/akveo/ng2-admin" title="Star &amp; Fork on GitHub" class="github-fork-ribbon"></a>
</body>
</html>