Pear Admin Flask 项目安装与使用教程
1. 项目的目录结构及介绍
Pear Admin Flask
├─applications # 应用
│ ├─configs # 配置文件
│ │ ├─ common.py # 普通配置
│ │ └─ config.py # 配置文件对象
│ ├─extensions # 注册插件
│ ├─models # 数据模型
│ ├─static # 静态资源文件
│ ├─templates # 静态模板文件
│ └─views # 视图部分
│ ├─admin # 后台管理视图模块
│ └─index # 前台视图模块
├─docs # 文档说明(占坑)
├─migrations # 迁移文件记录
├─requirement # 依赖文件
├─test # 测试文件夹(占坑)
└─.env # 项目的配置文件
目录结构说明
- applications: 应用目录,包含项目的核心代码。
- configs: 配置文件目录,包含项目的配置文件。
common.py
: 普通配置文件。config.py
: 配置文件对象。
- extensions: 注册插件目录,包含项目中使用的插件。
- models: 数据模型目录,包含项目的数据模型定义。
- static: 静态资源文件目录,包含项目的静态资源文件(如CSS、JS等)。
- templates: 静态模板文件目录,包含项目的HTML模板文件。
- views: 视图部分目录,包含项目的视图逻辑。
- admin: 后台管理视图模块。
- index: 前台视图模块。
- configs: 配置文件目录,包含项目的配置文件。
- docs: 文档说明目录,目前为占坑状态。
- migrations: 迁移文件记录目录,包含数据库迁移文件。
- requirement: 依赖文件目录,包含项目的依赖文件。
- test: 测试文件夹目录,目前为占坑状态。
- .env: 项目的配置文件,包含项目的配置信息。
2. 项目的启动文件介绍
项目的启动文件是 start.sh
,该文件用于启动 Flask 应用。
#!/bin/bash
# 启动 Flask 应用
flask run
启动文件说明
start.sh
: 这是一个 Bash 脚本,用于启动 Flask 应用。执行该脚本时,会调用flask run
命令来启动应用。
3. 项目的配置文件介绍
项目的配置文件主要位于 .env
文件中,该文件包含了项目的配置信息。
# MySql配置信息
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_DATABASE=PearAdminFlask
MYSQL_USERNAME=root
MYSQL_PASSWORD=root
# Redis 配置
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
# 密钥配置
SECRET_KEY='pear-admin-flask'
# 邮箱配置
MAIL_SERVER='smtp.qq.com'
MAIL_USERNAME='123@qq.com'
MAIL_PASSWORD='XXXXX' # 生成的授权码
配置文件说明
- MYSQL_HOST: MySQL 数据库的主机地址。
- MYSQL_PORT: MySQL 数据库的端口号。
- MYSQL_DATABASE: MySQL 数据库的名称。
- MYSQL_USERNAME: MySQL 数据库的用户名。
- MYSQL_PASSWORD: MySQL 数据库的密码。
- REDIS_HOST: Redis 数据库的主机地址。
- REDIS_PORT: Redis 数据库的端口号。
- SECRET_KEY: 应用的密钥配置。
- MAIL_SERVER: 邮箱服务器地址。
- MAIL_USERNAME: 邮箱用户名。
- MAIL_PASSWORD: 邮箱密码(通常为授权码)。
通过以上配置,可以快速启动并配置 Pear Admin Flask 项目。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考