Skip to content

Commit bb8a2cd

Browse files
committed
更新文档
1 parent d84ea70 commit bb8a2cd

12 files changed

+118
-2
lines changed

docs/cn/AdminPanel.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# 管理后台的说明
2+
3+
如果你已经按照文档首页的"如何开始"操作过,运行项目后应该可以看见下面的页面
4+
5+
![后台登陆](img/admin_login.jpg)
6+
7+
如果你看到的是空白页面或者404,代表你未正确的编译前端的网页文件,请检查以下的文件夹是否存在
8+
9+
![前端输出目录](img/frontend_dist.jpg)
10+
11+
初次登陆需要用默认的管理员账号和用户名,分别如下
12+
13+
- 用户名 admin
14+
- 密码 123456
15+
16+
登录后可以看到下面的页面
17+
18+
![后台页面](img/admin_panel.jpg)
19+
20+
左边是导航栏,右边是用户菜单栏,点击用户菜单栏下的关于网站可以查看当前的网站信息
21+
22+
![网站信息](img/about_website.jpg)
23+
24+
Demo提供的后台可以管理租户,用户和角色
25+
26+
只有主租户"Master"可以管理其他租户
27+
28+
![租户管理](img/tenant_manage.jpg)
29+
30+
管理租户时可以创建他们的超级管理员和设置密码,使用该租户和创建的管理员登录可以管理该租户下的数据
31+
32+
![租户编辑](img/tenant_edit.jpg)
33+
34+
在定时任务这里可以看到任务的运行状况和历史记录
35+
36+
![定时任务](img/scheduled_tasks.jpg)
37+
38+
如何往这个管理后台添加新功能请参考后面关于前端的文档

docs/cn/BackendStruction.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# 后端的项目结构
2+
3+
当你打开ZKWeb.MVVMDemo.sln,可以看到下面的结构
4+
5+
![backend_struction.jpg](img/backend_struction.jpg)
6+
7+
各个项目的作用如下
8+
9+
- ZKWeb.MVVMDemo.AspNetCore
10+
- Asp.Net Core的网站项目,只负责配置Asp.Net Core和启动网站,不保存业务代码
11+
- ZKWeb.MVVMDemo.Console
12+
- 运行测试使用的控制台项目,也可以用于命令行编译所有插件
13+
- ZKWeb.MVVMPlugins
14+
- 插件项目,包含业务代码的插件和前端网站的插件
15+
16+
其中ZKWeb.MVVMPlugins项目下的一个文件夹代表一个插件,插件的目录结构如下
17+
18+
![backend_plugin_struction.jpg](img/backend_plugin_struction.jpg)
19+
20+
- bin: 保存该插件编译出来的程序集文件
21+
- src: 插件的源代码,发布时可以不保留
22+
- Application: 应用层的代码
23+
- Dtos: 保存数据传输对象的文件夹
24+
- Mappers: 保存AutoMapper配置的文件夹
25+
- Services: 保存Api服务的文件夹
26+
- Components: 组件的代码
27+
- Translates: 保存翻译的文件夹
28+
- Domain: 领域层的代码
29+
- Entities: 保存实体类的文件夹
30+
- Repositories: 保存仓储的文件夹
31+
- Services: 保存领域服务的文件夹,主要的业务代码会在这里编写
32+
- plugin.json: 插件信息
33+
34+
插件信息的格式如下
35+
36+
``` json
37+
{
38+
"Name": "Crud Example For MVVM",
39+
"Version": "1.0",
40+
"Description": "Provide crud example",
41+
"Dependencies": [ "MVVM.Common.Base", "MVVM.Common.Organization" ]
42+
}
43+
```
44+
45+
网站的配置集中在`App_Data\config.json`管理,格式如下
46+
47+
注意插件的定义顺序就是插件的加载顺序,如果顺序有误会导致网站启动失败
48+
49+
``` json
50+
{
51+
"ORM": "EFCore",
52+
"Database": "SQLite",
53+
"ConnectionString": "Data Source={{App_Data}}/test.db;",
54+
"PluginDirectories": [
55+
"../ZKWeb.MVVMPlugins"
56+
],
57+
"Plugins": [
58+
"MVVM.Common.Base",
59+
"MVVM.Common.ApiExplorer",
60+
"MVVM.Common.TaskScheduler",
61+
"MVVM.Common.MultiTenant",
62+
"MVVM.Common.SessionState",
63+
"MVVM.Common.Captcha",
64+
"MVVM.Common.Organization",
65+
"MVVM.Example.CrudExample",
66+
"MVVM.Angular.Support",
67+
"MVVM.Angular.Website"
68+
]
69+
}
70+
```
71+
72+
更多的说明可以参考ZKWeb的官方文档:
73+
74+
- [网站结构](http://zkweb-framework.github.io/cn/site/core/website_struct/index.html)
75+
- [配置文件](http://zkweb-framework.github.io/cn/site/core/website_config/index.html)
76+
- [插件系统](http://zkweb-framework.github.io/cn/site/core/plugin/index.html)
77+
78+
前端的文件夹说明请参考后面的文档

docs/cn/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ npm run watch
5959

6060
- [ZKWeb的官方文档](http://zkweb-framework.github.io)
6161
- [ZKWeb的官方文档(备用))](http://zkweb.org/static/docs/index.html)
62-
- [后端的项目结构](./TODO.md)
63-
- [管理后台的说明](./TODO.md)
62+
- [后端的项目结构](./BackendStruction.md)
63+
- [管理后台的说明](./AdminPanel.md)
6464
- [插件的建立](./TODO.md)
6565
- [实体的建立](./TODO.md)
6666
- [数据的增删查改](./TODO.md)

docs/cn/img/about_website.jpg

62.4 KB
Loading

docs/cn/img/admin_login.jpg

24.3 KB
Loading

docs/cn/img/admin_panel.jpg

41.2 KB
Loading
11.6 KB
Loading

docs/cn/img/backend_struction.jpg

35.4 KB
Loading

docs/cn/img/frontend_dist.jpg

26.2 KB
Loading

docs/cn/img/scheduled_tasks.jpg

44.7 KB
Loading

0 commit comments

Comments
 (0)