Skip to content

Commit 3f82894

Browse files
authored
Update README.md
1 parent 9a1ea70 commit 3f82894

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TyAdmin: Django 基于Models 的 **No Code** 零代码零学习成本管理后台前后端生成工具, 由Django Restful Framework 和 Antd Design Pro V4 驱动
1+
# TyAdmin: Django 基于Models 的 **No Code** 零代码零学习成本管理后台前后端生成工具, 由Django Restful Framework 和 Ant Design Pro V4 驱动
22

33
![](https://img.shields.io/pypi/v/tyadmin-api-cli)
44
![](https://img.shields.io/pypi/wheel/tyadmin-api-cli)
@@ -25,12 +25,12 @@ TyAdmin: 只需要花五分钟阅读README即可快速上手,无额外文档
2525

2626
只需要设计好Model,在settings中配置需要生成哪些model,运行一条命令`python manage.py init_admin && python manage.py gen_all`
2727

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

33-
🎁 内置
33+
# 🎁 内置
3434

3535
## 1. 多种登录方式
3636

@@ -60,12 +60,12 @@ TyAdmin: 只需要花五分钟阅读README即可快速上手,无额外文档
6060

6161
![](http://cdn.pic.mtianyan.cn/blog_img/20201010192630.png)
6262

63-
# 快速上手
63+
# 📦 快速上手
6464

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

7070
```
7171
git clone https://github.com/mtianyan/tyadmin_api_cli.git
@@ -74,7 +74,7 @@ cd tyadmin_api_cli/demos/tyadmin_demo_init
7474
pip install -r requirement.txt
7575
```
7676

77-
### 2. 安装tyadmin-api-cli并注册tyadmin-api-cli
77+
## 2. 安装tyadmin-api-cli并注册tyadmin-api-cli
7878

7979
```diff
8080
pip install tyadmin-api-cli
@@ -100,7 +100,7 @@ TY_ADMIN_CONFIG = {
100100

101101
GEN_APPS: 填写你想要生成的app列表。
102102

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

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

@@ -112,7 +112,7 @@ python manage.py init_admin && python manage.py gen_all && cd tyadmin && npm ins
112112

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

117117
```diff
118118
INSTALLED_APPS = [
@@ -126,7 +126,7 @@ INSTALLED_APPS = [
126126
'tyadmin_api'
127127
```
128128

129-
### 6. 注册首页路由,api路由
129+
## 5. 注册首页路由,api路由
130130

131131
./tyadmin_demo/urls.py
132132

@@ -145,7 +145,7 @@ re_path('^xadmin/.*', AdminIndexView.as_view()),
145145
path('api/xadmin/v1/', include('tyadmin_api.urls')),
146146
```
147147

148-
### 7. 运行项目
148+
## 6. 运行项目
149149

150150
```
151151
python manage.py makemigrations
@@ -219,7 +219,7 @@ npm install
219219
npm run start:dev # 默认会运行在8001端口
220220
```
221221

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

224224
# 🤝 贡献者名单:
225225

@@ -239,6 +239,7 @@ npm run start:dev # 默认会运行在8001端口
239239

240240
Copyright (c) 2020 mtianyan
241241

242+
242243
# 附录
243244

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

0 commit comments

Comments
 (0)