purchasing/fuse-angular
3
0
Fork 0
mirror of https://github.com/richard-loafle/fuse-angular.git synced 2025-01-06 18:45:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Updated directory structure guide

Browse Source
This commit is contained in:
Sercan Yemen 2024-01-11 08:59:39 +03:00
parent 2821b90ed8
commit cedd61f71b
2 changed files with 1 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/app/modules/admin/docs/guides/development/directory-structure/directory-structure.html
View File

@ -236,47 +236,11 @@
If you use SSR (Server Side Rendering) you can even include your <strong>landing</strong> page as one of the modules and keep everything in a single app.
</p>
<h3>app/shared/</h3>
<p>
This directory is designed to contain anything re-usable such as components, directives and pipes. By default, it doesn't include any of them but when you create
one for your app, you can put it here.
</p>
<p>
The only file here is the <code>shared.module.ts</code> file which simply imports and exports some of the common Angular modules so you don't have to import them
one by one. You can just import the <code>shared.module.ts</code> into your module whenever you need one of those common modules.
</p>
<p>
Currently it imports and exports:
</p>
<ul>
<li>
<p><strong>CommonModule</strong></p>
<p>Required for common directives such as *ngIf and *ngFor</p>
</li>
<li>
<p><strong>FormsModule</strong></p>
<p>Required for form directives</p>
</li>
<li>
<p><strong>ReactiveFormsModule</strong></p>
<p>Required for reactive form directives</p>
</li>
</ul>
<p>
You can add/remove anything to/from the <code>shared.module.ts</code> file and use the module to import commonly used modules without needing to remember them
one by one.
</p>
<h2>assets/</h2>
<p>
Default Angular assets folder.
</p>
<h2>environments/</h2>
<p>
Default Angular environments folder.
</p>
<h2>styles/</h2>
<p>
This folder contains 4 different scss files:

23
src/app/modules/admin/docs/guides/development/directory-structure/directory-structure.ts
View File

@ -72,12 +72,10 @@ export class DirectoryStructureComponent implements OnInit
name : 'core/',
children: [
{name: 'auth/'},
{name: 'config/'},
{name: 'icons/'},
{name: 'navigation/'},
{name: 'transloco/'},
{name: 'user/'},
{name: 'core.module.ts'},
],
},
{
@ -88,8 +86,6 @@ export class DirectoryStructureComponent implements OnInit
{name: 'layout.component.html'},
{name: 'layout.component.scss'},
{name: 'layout.component.ts'},
{name: 'layout.module.ts'},
{name: 'layout.types.ts'},
],
},
{
@ -111,16 +107,9 @@ export class DirectoryStructureComponent implements OnInit
{name: 'landing/'},
],
},
{
name : 'shared/',
children: [
{name: 'shared.module.ts'},
],
},
{name: 'app.component.html'},
{name: 'app.component.scss'},
{name: 'app.component.ts'},
{name: 'app.module.ts'},
{name: 'app.resolvers.ts'},
{name: 'app.routing.ts'},
],
@ -145,7 +134,7 @@ export class DirectoryStructureComponent implements OnInit
{name: 'tailwind/'},
{name: 'validators/'},
{name: 'version/'},
{name: 'fuse.module.ts'},
{name: 'fuse.provider.ts'},
{name: 'index.ts'},
],
},
@ -160,13 +149,6 @@ export class DirectoryStructureComponent implements OnInit
{name: 'styles/'},
],
},
{
name : 'environments/',
children: [
{name: 'environment.prod.ts'},
{name: 'environment.ts'},
],
},
{
name : 'styles/',
children: [
@ -177,11 +159,8 @@ export class DirectoryStructureComponent implements OnInit
},
{name: 'favicon-16x16.png'},
{name: 'favicon-32x32.png'},
{name: 'global.d.ts'},
{name: 'index.html'},
{name: 'main.ts'},
{name: 'polyfills.ts'},
{name: 'test.ts'},
],
},
];