v0.8 release

Author: mtianyan

CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.8.0 (2020-12-01)
+
+#### Bug Fixes
+
+- 修复图片显示
+
+#### Features / Enhancement
+
+- 合并app级别菜单生成
+- 支持直接生成，不需要启动一个前端服务
+- 权限定义宽度
+
 ## 0.7.2 (2020-12-01)
 
 #### Bug Fixes

README.md

@@ -1,57 +1,69 @@
-# TyAdmin 基于Django Restful Framework 和 Antd Design Pro V4 的基于Models 的 **No Code** 零代码零学习成本管理后台前后端生成工具。
+# TyAdmin: Django 基于Models 的 **No Code** 零代码零学习成本管理后台前后端生成工具, 由Django Restful Framework 和 Antd Design Pro V4 驱动
 
 ![](https://img.shields.io/pypi/v/tyadmin-api-cli)
 ![](https://img.shields.io/pypi/wheel/tyadmin-api-cli)
 
-线上demo地址: https://tyadmin.funpython.cn/xadmin 账号: tyadmin 密码: tyadmin
+## 🎬 在线体验Demo
 
-TyAdmin: 只需要花五分钟按着README中快速上手配置，无额外文档，无框架学习成本，零代码，全自动！更强大！更现代化！功能更多！
+>账号: tyadmin 密码: tyadmin
+
+演示地址: https://tyadmin.funpython.cn/xadmin 
+
+**No Code!!! 一行代码都不写，就能拥有的现代化后台管理**
+
+TyAdmin: 只需要花五分钟阅读README即可快速上手，无额外文档，无框架学习成本，不用自己写一行代码，全自动的后台，你值得拥有！
+
+📨 互动交流反馈QQ群: 304094780
+
+[直接上手](#快速上手) 
+
+# ✨ 特性
 
 0. 自动生成前后端管理后台，页面接口神奇全自动对接。登录验证，修改密码，Dashboard数据统计。
 1. 一次拥有 **增删改查，筛选，搜索，数据全量导出，选择导出** 
-2. 外键字段，多对多字段，富文本，文件，图片，django自带权限系统，
-3. 已兼容第三方 django-celery-beat 后台管理
+2. 外键字段，多对多字段，富文本，文件，图片，django自带权限系统
+
+只需要设计好Model，在settings中配置需要生成哪些model，运行一条命令`python manage.py init_admin && python manage.py gen_all`
+
+>后端代码生成一个django app到项目目录, 只需注册一下， 无需再写一行代码！ 代码归你掌控，无阻二次开发！
+>前端生成一个完整的Antd design pro V4项目，只需启动一次，无需再写一行代码！ 代码归你掌控，无阻二次开发！
+
+前端页面，后端接口，路由，菜单全部自动对接,你只需要拷贝文档，修改配置，不需要写一行代码！！
+
+🎁 内置
 
-## 多种登录方式
+## 1. 多种登录方式
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201130234228.png)
 
-## 内嵌自动dashboard，自动注册现有model count 数据。
+## 2. 内嵌自动dashboard，自动注册现有model count 数据。
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201130234054.png)
 
-## 全自动的列表展示，增删改查， 筛选，搜索，导出Excel
+## 3. 全自动的列表展示，增删改查， 筛选，搜索，导出Excel
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201130234448.png)
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201130234525.png)
 
-## django自带权限组支持，外键蓝点小标记pop支持
+## 4. django自带权限组支持，外键蓝点小标记pop支持
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201130234705.png)
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201130234753.png)
 
-## 基于Model定义的表单字段级别自动验证
+## 5. 基于Model定义的表单字段级别自动验证
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201010194705.png)
 
-## 内嵌富文本支持,仅需把字段定义为`richTextField`,无需任何额外集成。
+## 6. 内嵌富文本支持,仅需把字段定义为`richTextField`,无需任何额外集成。
 
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201010192630.png)
 
-交流反馈群: 304094780
-
-只需要设计好Model，在settings中配置需要生成哪些model，运行一条命令`python manage.py init_admin && python manage.py gen_all`
-
->后端代码生成一个django app到项目目录, 只需注册一下， 无需再写一行代码！ 代码归你掌控，无阻二次开发！
->前端生成一个完整的Antd design pro V4项目，只需启动一次，无需再写一行代码！ 代码归你掌控，无阻二次开发！
-
-前端页面，后端接口，路由，菜单全部自动对接。
-
-# 快速上手 (已有项目可从第二步开始，注意修改GEN_APPS 变量为自己需要生成的app列表)
+# 快速上手 
 
->如有问题，可对比demos下tyadmin_demo_finish项目找自己的不同
+>已有项目可从第二步开始，注意修改GEN_APPS 变量为自己需要生成的app列表
+>如有问题，可对比demos下tyadmin_demo_finish项目找自己的不同,以及查看[QA环节](#QA环节)
 
 ### 1. 下载demo项目安装依赖
 
@@ -64,46 +76,76 @@ pip install -r requirement.txt
 
 ### 2. 安装tyadmin-api-cli并注册tyadmin-api-cli
 
-```
+```diff
 pip install tyadmin-api-cli
 
 INSTALLED_APPS = [
++    'captcha',
++    'tyadmin_api_cli',
+]
+
++TY_ADMIN_CONFIG = {
++    'GEN_APPS': ['demo']
++}
+
+# 方便拷贝
+
     'captcha',
     'tyadmin_api_cli',
-]
 
 TY_ADMIN_CONFIG = {
     'GEN_APPS': ['demo']
 }
 ```
 
-GEN_APPS: 填写你想要生成的app列表。
+GEN_APPS: 填写你想要生成的app列表。 
 
 ### 3. 初始化 后端app(tyadmin_api) + 前端项目(tyadmin)  && 生成后端自动化的视图，过滤器，路由，序列器 + 前端页面及路由菜单
 
+生成后端页面依赖，需安装Node.js -> https://www.runoob.com/nodejs/nodejs-install-setup.html
+
+>安装Node.js 10以上，推荐安装版本Latest LTS Version: 12.19.0
+
 ```
-python manage.py init_admin && python manage.py gen_all
+python manage.py init_admin && python manage.py gen_all && cd tyadmin && npm install && npm run build
 ```
 
-### 5. 注册生成出的app
+>耐心等待一会，build 会输出 前端页面到templates文件夹，生成前端js,css 等到static文件夹
+
+### 5. 注册生成出的django app
 
 ```diff
 INSTALLED_APPS = [
     'captcha',
     'tyadmin_api_cli',
 +   'tyadmin_api'
 ]
+
+# 方便拷贝
+
+'tyadmin_api'
 ```
 
-### 6. 注册路由
+### 6. 注册首页路由，api路由
 
-demos/tyadmin_demo_complete/tyadmin_demo/urls.py
+./tyadmin_demo/urls.py
 
-```
-    path('api/xadmin/v1/', include('tyadmin_api.urls')),
+```diff
++ from tyadmin_api.views import AdminIndexView
+
+urlpatterns = [
++    re_path('^xadmin/.*', AdminIndexView.as_view()),
++    path('api/xadmin/v1/', include('tyadmin_api.urls')),
+]
+
+# 方便拷贝
+from tyadmin_api.views import AdminIndexView
+
+re_path('^xadmin/.*', AdminIndexView.as_view()),
+path('api/xadmin/v1/', include('tyadmin_api.urls')),
 ```
 
-### 7. 运行后端项目，运行前端项目
+### 7. 运行项目
 
 ```
 python manage.py makemigrations
@@ -112,19 +154,92 @@ python manage.py createsuperuser # 创建一个可以登入后台的用户
 python manage.py runserver # 默认运行在8000端口
 ```
 
-安装Node.js -> https://www.runoob.com/nodejs/nodejs-install-setup.html
+访问http://127.0.0.1:8000/xadmin/ 输入刚才创建的用户名密码登录
 
->安装Node.js 10以上，推荐安装版本Latest LTS Version: 12.19.0
+至此大功告成！
+
+>如果没有成功看到页面，请查看QA部分
+
+# QA环节
+
+## 0. `TemplateDoesNotExist at /xadmin/ TyAdmin/index.html`
+
+settings.py 中配置templates 路径
+
+```diff
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+-        'DIRS': [],
++        'DIRS': [os.path.join(BASE_DIR, 'templates')],
+```
+## 1. 卡在loading页面，一直无法登陆
+
+settings.py 中配置static 路径
+
+```
+if DEBUG:
+    STATICFILES_DIRS = [
+        os.path.join(BASE_DIR, "static"),
+    ]
+else:
+    STATIC_ROOT = os.path.join(BASE_DIR, 'static')
+```
+
+## 2. 图片没有正常显示
+
+urls.py 
+
+```
+from django.views.static import serve
+
+urlpatterns = [
+re_path('media/(?P<path>.*)', serve, {"document_root": settings.MEDIA_ROOT}),
+]
+```
+
+## 3. 当项目新增了model，我该如何为新model生成前端页面+后端接口
+
+```
++TY_ADMIN_CONFIG = {
++    'GEN_APPS': ['demo','new_app']
++}
+```
+如上GEN_APPS 中添加新app的name，然后运行下面命令
+
+```
+python manage.py gen_all && cd tyadmin && npm run build
+```
+
+## 4. 如何运行生成的前端独立项目
 
 ```
 cd tyadmin
 npm install
 npm run start:dev # 默认会运行在8001端口
 ```
 
-访问http://127.0.0.1:8001/xadmin/ 输入刚才创建的用户名密码登录查看系统
+请确认django运行在8000端口，访问http://127.0.0.1:8001/xadmin/
+
+# 🤝 贡献者名单:
+
+[longyn](https://github.com/longyn)
 
-# 附录(随意了解一下即可)
+# 🤟 打赏
+
+很高兴我的项目代码或许对你有帮助，请我吃包辣条或喝瓶可乐吧!
+
+微信打赏:
+
+![mark](http://myphoto.mtianyan.cn/blog/180302/i52eHgilfD.png?imageslim)
+
+# 🔑 License
+
+[MIT](https://github.com/go-admin-team/go-admin/blob/master/LICENSE.md)
+
+Copyright (c) 2020 mtianyan
+
+# 附录
 
 ## model->前端对应关系
 
@@ -143,9 +258,13 @@ npm run start:dev # 默认会运行在8001端口
 | DateField| Date选择器|
 | DateTimeField| DateTime选择器|
 
-### ForeignKey自动生成下拉单选菜单, ManyToManyField自动生成下拉多选菜单
+### ForeignKey自动生成下拉单选菜单, ManyToManyField自动生成下拉多选菜单或穿梭框
 
+![](http://cdn.pic.mtianyan.cn/blog_img/20201202214922.png)
 
+![](http://cdn.pic.mtianyan.cn/blog_img/20201202214936.png)
+
+![](http://cdn.pic.mtianyan.cn/blog_img/20201202214957.png)
 
 ### richTextField 自动生成富文本
 
@@ -230,4 +349,3 @@ last_login = DateTimeField(verbose_name="上次登录")
 ![](http://cdn.pic.mtianyan.cn/blog_img/20201010195116.png)
 
 
-