修改文档

This commit is contained in:
不胜舟
2023-04-06 16:25:04 +08:00
parent c5a8a1a653
commit 2364ebb519
3 changed files with 18 additions and 43 deletions
+16 -41
View File
@@ -30,29 +30,8 @@
#### 项目简介
Pear Admin Flask 基于 Flask 的后台管理系统,拥抱应用广泛的python语言,通过使用本系统,即可快速构建你的功能业务
项目旨在为 python 开发者提供一个后台管理系统的模板,可以快速构建信息管理系统。
Pear Admin Flask 有以下几个版本:
**[master分支版本 ](https://gitee.com/pear-admin/pear-admin-flask/tree/master/)**
flask 2.0.1 + flask-sqlalchemy + 权限验证 + Flask-APScheduler 定时任务 + marshmallow 序列化与数据验证
master 分支为主分支,是功能最全、页面最多的分支。
**[mini 分支版本](https://gitee.com/pear-admin/pear-admin-flask/tree/mini/)**
flask 2.0.1 + flask-sqlalchemy + 权限验证 + flask-restful
此版本主要是提供一个最个简的 pear admin flask 快速开发的模板,可以帮助用户快速搭建一个后台管理系统。
因为一些历史问题,例如 flask-restful 不再继续更新等,此版本不会也再继续更新,而会将精力投入到 main 分支当中去。
如果想使用这个分支进行开发,可以看 https://www.bilibili.com/video/BV1FF411b7bS 进行学习。
**[main 分支版本](https://gitee.com/pear-admin/pear-admin-flask/tree/main/)**
main 分支是对 mini 分支的后续,目前还在开发中。
项目使用flask-sqlalchemy + 权限验证 + Flask-APScheduler 定时任务 + marshmallow 序列化与数据验证
#### 内置功能
@@ -64,28 +43,10 @@ main 分支是对 mini 分支的后续,目前还在开发中。
- [x] 服务监控:监视当前系统CPU、内存、磁盘、python版本,运行时长等相关信息。
- [x] 文件上传: 图片上传示例
- [x] 定时任务: 简单的定时任务
- [ ] 代码生成: 构想中....
#### 项目结构
```
Pear Admin Flask
├─applications # 应用
│ ├─configs # 配置文件
│ │ ├─ common.py # 普通配置
│ │ └─ config.py # 配置文件对象
│ ├─extensions # 注册插件
│ ├─models # 数据模型
│ ├─static # 静态资源文件
│ ├─templates # 静态模板文件
│ └─views # 视图部分
│ ├─admin # 后台管理视图模块
│ └─index # 前台视图模块
├─docs # 文档说明(占坑)
├─migrations # 迁移文件记录
├─requirement # 依赖文件
├─test # 测试文件夹(占坑)
└─.env # 项目的配置文件
```
@@ -142,7 +103,7 @@ flask upgrade
flask init
```
执行 flask run 命令启动项目
执行 python app.py 命令启动项目
#### 命令行创建视图
@@ -154,6 +115,20 @@ flask new --type view --name test/a
# 自动注册蓝图
# 访问http://127.0.0.1:5000/test/a/
```
Pear Admin Flask 还有以下几个版本:
**[mini 分支版本](https://gitee.com/pear-admin/pear-admin-flask/tree/mini/)**
flask 2.0.1 + flask-sqlalchemy + 权限验证 + flask-restful
此版本主要是提供一个最个简的 pear admin flask 快速开发的模板,可以帮助用户快速搭建一个后台管理系统。
因为一些历史问题,例如 flask-restful 不再继续更新等,此版本不会也再继续更新,而会将精力投入到 main 分支当中去。
如果想使用这个分支进行开发,可以看 https://www.bilibili.com/video/BV1FF411b7bS 进行学习。
**[main 分支版本](https://gitee.com/pear-admin/pear-admin-flask/tree/main/)**
main 分支是对 mini 分支的后续,目前还在开发中。
#### 预览项目
+1 -1
View File
@@ -686,4 +686,4 @@ def init_db():
print("用户角色数据存入")
add_role_power()
print("角色权限数据存入")
print("数据初始化完成,请使用flask run命令运行")
print("数据初始化完成,请使用python app.py命令运行")
+1 -1
View File
@@ -51,7 +51,7 @@ class BaseConfig:
MYSQL_PASSWORD = "123456"
MYSQL_HOST = "127.0.0.1"
MYSQL_PORT = 3306
MYSQL_DATABASE = "PearAdminFlask1"
MYSQL_DATABASE = "PearAdminFlask"
# mysql 数据库的配置信息
SQLALCHEMY_DATABASE_URI = f"mysql+pymysql://{MYSQL_USERNAME}:{urlquote(MYSQL_PASSWORD)}@{MYSQL_HOST}:{MYSQL_PORT}/{MYSQL_DATABASE}?charset=utf8mb4"