Skip to content

Commit 3d8a24c

Browse files
committed
Merge remote-tracking branch 'origin/master' into master
# Conflicts: # README.md
2 parents 971202d + 0a8e094 commit 3d8a24c

File tree

1 file changed

+46
-45
lines changed

1 file changed

+46
-45
lines changed

README.md

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,61 @@
1313

1414
TyAdmin: 只需要花五分钟阅读README即可快速上手,无额外文档,无框架学习成本,不用自己写一行代码,全自动的后台,你值得拥有!
1515

16+
# 🤟 快速上手
17+
1618
📨 互动交流反馈QQ群: 304094780
1719

1820
[直接上手](#快速上手)
1921

2022
# ✨ 特性
2123

22-
0. 自动生成前后端管理后台,页面接口神奇全自动对接。登录验证,修改密码,Dashboard数据统计。
23-
1. 一次拥有 **增删改查,筛选,搜索,数据全量导出,选择导出**
24-
2. 外键字段,多对多字段,富文本,文件,图片,django自带权限系统
24+
- 自动生成前后端管理后台,页面接口神奇全自动对接。登录验证,修改密码,Dashboard数据统计。
25+
- 一次拥有 **增删改查,筛选,搜索,数据全量导出,选择导出**
26+
- **外键字段,多对多字段,富文本,文件,图片,django自带权限系统**
2527

26-
只需要设计好Model,在settings中配置需要生成哪些model,运行一条命令`python manage.py init_admin && python manage.py gen_all`
28+
只需要设计好Model,在settings中配置需要生成哪些model,运行命令: [快速上手](#快速上手)
2729

28-
>后端代码生成一个django app到项目目录, 只需注册一下, 无需再写一行代码! 代码归你掌控,无阻二次开发!
29-
>前端生成一个完整的Antd design pro V4项目,只需启动一次,无需再写一行代码! 代码归你掌控,无阻二次开发!
30+
>后端生成一个django app到项目目录, 只需注册一下, 无需再写一行代码! 代码归你掌控,无阻二次开发!
31+
>前端生成一个Ant Design Pro V4项目,只需启动一次,无需再写一行代码! 代码归你掌控,无阻二次开发!
3032
3133
前端页面,后端接口,路由,菜单全部自动对接,你只需要拷贝文档,修改配置,不需要写一行代码!!
3234

35+
# 🎁 内置
36+
37+
## 1. 多种登录方式
38+
39+
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234228.png)
40+
41+
## 2. 内嵌自动dashboard,自动注册现有model count 数据。
42+
43+
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234054.png)
44+
45+
## 3. 全自动的列表展示,增删改查, 筛选,搜索,导出Excel
46+
47+
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234448.png)
48+
49+
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234525.png)
50+
51+
## 4. django自带权限组支持,外键蓝点小标记pop支持
52+
53+
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234705.png)
54+
55+
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234753.png)
56+
57+
## 5. 基于Model定义的表单字段级别自动验证
58+
59+
![](http://cdn.pic.mtianyan.cn/blog_img/20201010194705.png)
60+
61+
## 6. 内嵌富文本支持,仅需把字段定义为`richTextField`,无需任何额外集成。
62+
63+
![](http://cdn.pic.mtianyan.cn/blog_img/20201010192630.png)
64+
3365
# 快速上手
3466

3567
>已有项目可从第二步开始,注意修改GEN_APPS 变量为自己需要生成的app列表
3668
>如有问题,可对比demos下tyadmin_demo_finish项目找自己的不同,以及查看[QA环节](#QA环节)
3769
38-
### 1. 下载demo项目安装依赖
70+
## 1. 下载demo项目安装依赖
3971

4072
```
4173
git clone https://github.com/mtianyan/tyadmin_api_cli.git
@@ -44,7 +76,7 @@ cd tyadmin_api_cli/demos/tyadmin_demo_init
4476
pip install -r requirement.txt
4577
```
4678

47-
### 2. 安装tyadmin-api-cli并注册tyadmin-api-cli
79+
## 2. 安装tyadmin-api-cli并注册tyadmin-api-cli
4880

4981
```diff
5082
pip install tyadmin-api-cli
@@ -70,7 +102,7 @@ TY_ADMIN_CONFIG = {
70102

71103
GEN_APPS: 填写你想要生成的app列表。
72104

73-
### 3. 初始化 后端app(tyadmin_api) + 前端项目(tyadmin) && 生成后端自动化的视图,过滤器,路由,序列器 + 前端页面及路由菜单
105+
## 3. 初始化 后端app(tyadmin_api) + 前端项目(tyadmin) && 生成后端自动化的视图,过滤器,路由,序列器 + 前端页面及路由菜单
74106

75107
生成后端页面依赖,需安装Node.js -> https://www.runoob.com/nodejs/nodejs-install-setup.html
76108

@@ -82,7 +114,7 @@ python manage.py init_admin && python manage.py gen_all && cd tyadmin && npm ins
82114

83115
>耐心等待一会,build 会输出 前端页面到templates文件夹,生成前端js,css 等到static文件夹
84116
85-
### 5. 注册生成出的django app
117+
## 4. 注册生成出的django app
86118

87119
```diff
88120
INSTALLED_APPS = [
@@ -96,7 +128,7 @@ INSTALLED_APPS = [
96128
'tyadmin_api'
97129
```
98130

99-
### 6. 注册首页路由,api路由
131+
## 5. 注册首页路由,api路由
100132

101133
./tyadmin_demo/urls.py
102134

@@ -115,7 +147,7 @@ re_path('^xadmin/.*', AdminIndexView.as_view()),
115147
path('api/xadmin/v1/', include('tyadmin_api.urls')),
116148
```
117149

118-
### 7. 运行项目
150+
## 6. 运行项目
119151

120152
```
121153
python manage.py makemigrations
@@ -130,38 +162,6 @@ python manage.py runserver # 默认运行在8000端口
130162

131163
>如果没有成功看到页面,请查看QA部分
132164
133-
134-
🎁 内置
135-
136-
## 1. 多种登录方式
137-
138-
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234228.png)
139-
140-
## 2. 内嵌自动dashboard,自动注册现有model count 数据。
141-
142-
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234054.png)
143-
144-
## 3. 全自动的列表展示,增删改查, 筛选,搜索,导出Excel
145-
146-
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234448.png)
147-
148-
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234525.png)
149-
150-
## 4. django自带权限组支持,外键蓝点小标记pop支持
151-
152-
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234705.png)
153-
154-
![](http://cdn.pic.mtianyan.cn/blog_img/20201130234753.png)
155-
156-
## 5. 基于Model定义的表单字段级别自动验证
157-
158-
![](http://cdn.pic.mtianyan.cn/blog_img/20201010194705.png)
159-
160-
## 6. 内嵌富文本支持,仅需把字段定义为`richTextField`,无需任何额外集成。
161-
162-
![](http://cdn.pic.mtianyan.cn/blog_img/20201010192630.png)
163-
164-
165165
# QA环节
166166

167167
## 0. `TemplateDoesNotExist at /xadmin/ TyAdmin/index.html`
@@ -221,7 +221,7 @@ npm install
221221
npm run start:dev # 默认会运行在8001端口
222222
```
223223

224-
请确认django运行在8000端口,访问http://127.0.0.1:8001/xadmin/
224+
请确认django运行在8000端口,访问 http://127.0.0.1:8001/xadmin/
225225

226226
## 5. 如何更新tyadmin版本,强制覆盖上次生成
227227

@@ -249,6 +249,7 @@ TY_ADMIN_CONFIG = {
249249

250250
Copyright (c) 2020 mtianyan
251251

252+
252253
# 附录
253254

254255
## model->前端对应关系

0 commit comments

Comments
 (0)