Comment on page
Getting Started
Ng-Matero is a project based in Angular Material Components, so you need to know the basics of TypeScript and Sass.
The easiest way to initialize the project is to use the CLI, you can customize admin template and theme. See Project Init for details.
$ ng new <project-name>
$ cd <project-name>
$ ng add ng-matero
Except using CLI, you can also clone the Starter repo, but Starter has just side nav layout.
$ git clone --depth=1 [email protected]:ng-matero/starter.git <project-name>
$ cd <project-name>
$ npm install
It is recommended to run the program using hmr, do not use
npm start
or ng serve
.$ npm run hmr
Clone the whole repo.
Navigate to
http://localhost:4200/
. The app will automatically reload if you change any of the source files.
├── src
│ ├── app
│ │ ├── core
│ │ │ ├── bootstrap
│ │ │ │ ├── menu.service.ts
│ │ │ │ ├── settings.service.ts
│ │ │ │ └── startup.service.ts
│ │ │ ├── interceptors
│ │ │ │ └── default.interceptor.ts
│ │ │ │── core.module.ts
│ │ │ │── **
│ │ │ └── settings.ts
│ │ ├── routes
│ │ │ ├── **
│ │ │ ├── routes-routing.module.ts
│ │ │ └── routes.module.ts
│ │ ├── shared
│ │ │ |—— **
│ │ │ └── shared.module.ts
│ │ ├── theme
│ │ │ ├── admin-layout
│ │ │ ├── auth-layout
│ │ │ ├── style
│ │ │ ├── style.scss
│ │ | └── theme.module.ts
│ │ ├── app.component.ts
│ │ ├── app.module.ts
│ │ └── material.module.ts
│ ├── assets
│ ├── environments
│ ├── styles
│ │ ├── grid
│ │ ├── helpers
│ │ ├── plugins
│ │ ├── **
│ │ ├── _app-theme.scss
│ │ └── themes.scss
└── └── styles.scss
The directory structure follows the Angular style guide, and is also for convenience of the CLI to add business module. There may be some small adjustments in the future.
The project runs
startup.service
by default. Some key information (such as menu data, user data, etc.) before the project starts can be written in the startup.service
.Last modified 3yr ago