update README.md and outlines project goals, features, installation g…

…uidelines, deployment details, etc. In addition, we encourage open-source projects to have a code of conduct and contributing guidelines.

README.md

@@ -1,19 +1,138 @@
-# Platform For Plate
+<h1 align="center">
+Platform For Plate
+</h1>
 
----
+<div align="center">
 
-## Spring boot 3 application
+The system management platform is an application developed based on Spring Boot 3 and Angular. It is used to manage
+basic system information such as users, roles, tenants, menus, etc., and provides basic platform functions.
 
-Spring boot project
+</div>
 
-## Angular pc web
+## ✨ Features
 
-Angular web console project
+- Provide unified user, role, and tenant management.
+- Provide permission control function.
+- Provide menu management functions.
+- Provide basic platform functions, such as log management, audit management, etc..
 
-## Thanks
+## ☀️ License
 
------
-![jetbrains](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png?_ga=2.50027366.1351545062.1678115252-1057454299.1678115252&_gl=1*1difgeb*_ga*MTA1NzQ1NDI5OS4xNjc4MTE1MjUy*_ga_9J976DJZ68*MTY3ODExNTI1MS4xLjEuMTY3ODExNTI4Mi4wLjAuMA..)
+[MIT](https://github.com/vnobo/plate/blob/main/LICENSE)
 
-* [jetbrains](https://www.jetbrains.com)
-* [https://jb.gg/OpenSource](https://jb.gg/OpenSource)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FNG-ZORRO%2Fng-zorro-antd.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FNG-ZORRO%2Fng-zorro-antd?ref=badge_shield)
+
+## 🖥 Environment Support
+
+* Spring boot `3.3.2`
+*
+Angular `^17.2.1` [![npm package](https://img.shields.io/npm/v/ng-zorro-antd.svg?style=flat-square)](https://www.npmjs.org/package/ng-zorro-antd)
+* ng-zorro-antd `17.2.0`
+* Server-side Rendering
+* Modern browsers including the following [specific versions](https://angular.io/guide/browser-support)
+* [Electron](http://electron.atom.io/)
+
+## 📦 Installation
+
+**We recommend using `@angular/cli` to install**. It not only makes development easier, but also allows you to take
+advantage of the rich ecosystem of angular packages and tooling.
+
+```bash
+$ ng new PROJECT_NAME
+$ cd PROJECT_NAME
+$ ng add plate-platform
+```
+
+> More information about `@angular/cli` [here](https://github.com/angular/angular-cli).
+
+You can also install `plate-platform` with npm or yarn
+
+```bash
+$ npm install plate-platform
+```
+
+## 🔨 Usage
+
+Import the component modules you want to use into your `app.module.ts` file
+and [feature modules](https://angular.io/guide/feature-modules).
+
+```ts
+import {NzButtonModule} from 'plate-platform/button';
+
+@NgModule({
+    imports: [NzButtonModule]
+})
+export class AppModule {
+}
+```
+
+> `@angular/cli` users won't have to worry about the things below but it's good to know.
+
+And import style and SVG icon assets file link in `angular.json`.
+
+```diff
+{
+  "assets": [
++   {
++     "glob": "**/*",
++     "input": "./node_modules/@ant-design/icons-angular/src/inline-svg/",
++     "output": "/assets/"
++   }
+  ],
+  "styles": [
++   "node_modules/ng-zorro-antd/plate-platform.min.css"
+  ]
+}
+```
+
+See [Getting Started](https://ng.ant.design/docs/getting-started/en) for more details.
+
+## 🔗 Links
+
+* [ng-zorro-antd](https://github.com/NG-ZORRO/ng-zorro-antd-mobile)
+* [ng-alain](https://github.com/ng-alain/ng-alain)
+* [Snippet extension for VSCode](https://marketplace.visualstudio.com/items?itemName=cipchk.ng-zorro-vscode)
+
+## ⌨️ Development
+
+```bash
+$ git clone https://github.com/vnobo/plate.git
+$ cd plate/ui/
+$ npm install
+$ npm run start
+```
+
+Browser would open automatically.
+
+## 🤝 Contributing
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/NG-ZORRO/ng-zorro-antd/pulls)
+
+We welcome all contributions.You can submit any
+ideas as [pull requests](https://github.com/NG-ZORRO/ng-zorro-antd/pulls) or
+as [GitHub issues](https://github.com/NG-ZORRO/ng-zorro-antd/issues).
+
+
+> If you're new to posting issues, we ask that you read [*How To Ask Questions The Smart
+Way*](http://www.catb.org/~esr/faqs/smart-questions.html) (**This guide does not provide actual support services for
+this project!**), [How to Ask a Question in Open Source Community](https://github.com/seajs/seajs/issues/545)
+> and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) prior to posting. Well
+> written bug reports help us help you!
+
+Thanks to [JetBrains](https://www.jetbrains.com/?from=ng-zorro-antd) for supporting us free open source licenses.
+
+[![JetBrains](https://img.alicdn.com/tfs/TB1sSomo.z1gK0jSZLeXXb9kVXa-120-130.svg)](https://www.jetbrains.com/?from=ng-zorro-antd)
+
+## ❓ Help from the Community
+
+For questions on how to use ng-zorro-antd, please post questions
+to [<img alt="Stack Overflow" src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-logo.svg?v=2bb144720a66" width="140" />](http://stackoverflow.com/questions/tagged/ng-zorro-antd)
+using the `plate-platform` tag. If you're not finding what you need on stackoverflow, you can find us
+on [![Discord](https://img.shields.io/discord/748677963142135818?label=Discord&style=flat-square)](https://discord.com/channels/748677963142135818/764322550712893451)
+as well.
+
+As always, we encourage experienced users to help those who are not familiar with `plate-platform`!
+
+## 🎉 Users
+
+> We list some users here!

ui/projects/web/src/app/pages/home/home.component.html

@@ -9,20 +9,31 @@
     <nz-sider [nzCollapsedWidth]="0" nzBreakpoint="md" nzCollapsible nzWidth="14.6rem">
       <ul class="sider-menu" nz-menu nzMode="inline" nzTheme="dark">
         <li nz-menu-item><i class="bi bi-p-circle-fill mx-2"></i><a routerLink="/home">首页</a></li>
+          @for (menu of menus$|async; track menu) {
+              <li nz-submenu nzIcon="user" nzOpen nzTitle="{{menu.name}}">
+                  <ul>
+                      @for (child of menu.children; track child) {
+                          <li nz-menu-item><a [state]="child" routerLink=".{{child.path}}"
+                                              routerLinkActive="active">{{ child.name }}</a></li>
+                      }
+                  </ul>
+              </li>
+          }
         <li *ngFor="let menu of menus$|async; index as i" nz-submenu nzIcon="user" nzOpen
             nzTitle="{{menu.name}}">
           <ul>
             <li *ngFor="let child of  menu.children; index as i" nz-menu-item>
-              <a [state]="child" routerLink=".{{child.path}}" routerLinkActive="active">{{child.name}}</a>
+                <a [state]="child" routerLink=".{{child.path}}" routerLinkActive="active">{{ child.name }}</a>
             </li>
           </ul>
         </li>
       </ul>
     </nz-sider>
     <nz-layout class="inner-layout">
       <nz-breadcrumb>
-        <nz-breadcrumb-item *ngFor="let breadcrumb of breadcrumbs; index as i">
-          <a routerLink=".{{breadcrumb.url}}">{{breadcrumb.label}}</a></nz-breadcrumb-item>
+          @for (breadcrumb of breadcrumbs; track breadcrumb) {
+              <nz-breadcrumb-item><a routerLink=".{{breadcrumb.url}}">{{ breadcrumb.label }}</a></nz-breadcrumb-item>
+          }
       </nz-breadcrumb>
       <nz-content>
         <div class="inner-content">

ui/projects/web/src/app/pages/layout/layout.module.ts

@@ -0,0 +1,15 @@
+import {NgModule} from '@angular/core';
+import {CommonModule} from '@angular/common';
+import {PageComponent} from "./page/page.component";
+
+
+@NgModule({
+  declarations: [],
+  imports: [
+    CommonModule,
+    PageComponent
+  ],
+  exports: [PageComponent]
+})
+export class LayoutModule {
+}

ui/projects/web/src/app/pages/layout/page/page.component.html

@@ -0,0 +1 @@
+<p>page works!</p>

ui/projects/web/src/app/pages/layout/page/page.component.scss

@@ -0,0 +1,4 @@
+:host {
+  min-width: 100%;
+  min-height: 100%;
+}

ui/projects/web/src/app/pages/layout/page/page.component.ts

@@ -0,0 +1,12 @@
+import {Component} from '@angular/core';
+
+@Component({
+  selector: 'app-page',
+  standalone: true,
+  imports: [],
+  templateUrl: './page.component.html',
+  styleUrl: './page.component.scss'
+})
+export class PageComponent {
+
+}