README.md

Flask-Bigger for education

Flask大型应用骨架-教育专用

开始使用

1. git clone https://github.com/gsw945/flask-bigger4edu.git
2. cd flask-bigger4edu
3. pip install -r requirements.txt
4. python run.py

后端说明

使用 Python 3 (理论上 Python 2可以正常运行，但是未测试)

后端-使用的第三方库

• Flask
  • GitHub
  • PyPi
  • Doc
  • Doc-v0.10(中文)
  • Doc-v0.11(中文)
  • Doc-v1.0.2(中文)
• Jinja2
  • GitHub
  • PyPi
  • Doc
  • Doc(中文)
  • Doc(中文)

安装依赖包

pip install -r requirements.txt

数据库迁移

1. 初始化迁移配置

   python manage.py db init

2. 生成迁移文件

   python manage.py db migrate

3. 执行迁移操作(更改到数据库)

   python manage.py db upgrade

4. 查看帮助

   python manage.py db --help

安装依赖包

pip install -r requirements.txt

开发运行

python ./run.py
# 或者
python manage.py runserver --host 0.0.0.0 --port 5555

# 查看运行帮助
python manage.py runserver --help

---

前端说明

前端-使用的第三方库

• Bootstrap
  • GitHub
  • Doc-com
  • Doc(中文)

(关键)目录、文件说明

├── backend                            # 后端文件目录
│   ├── __init__.py                    # 包标识
│   ├── app_env.py                     # 应用环境变量配置获取
│   ├── app_map.py                     # 子应用汇总入口
│   ├── apps                           # 子应用目录(结构可参考admin)
│   │   ├── ...                        # 其他子应用
│   │   ├── home                       # home子应用(站点首页)
│   │   │   ├── main.py                # home应用-主文件
│   │   │   └── views.py               # home应用-视图文件
│   │   └── __init__.py                # 包标识
│   ├── core                           # 站点核心(独立于具体业务)文件目录
│   │   ├── __init__.py                # 包标识
│   │   ├── cdn.py                     # CDN
│   │   ├── database.py                # 数据库
│   │   ├── exception.py               # 异常
│   │   ├── hook.py                    # 钩子
│   │   ├── middlewares.py             # 中间件
│   │   ├── route.py                   # 路由
│   │   └── template.py                # 模板
│   ├── startup.py                     # 站点启动入口文件
│   └── utils                          # 工具库目录
│       ├── __init__.py                # 包标识
│       ├── classes.py                 # 辅助类
│       ├── database.py                # 数据库操作辅助函数封装
│       └── functions.py               # 辅助函数
├── config                             # 外部配置
│   ├── cdn.json                       # CDN资源列表
│   ├── database.json                  # 数据库配置
│   ├── example-database-mysql.json    # 数据库配置文件示例(MySQL)
│   └── example-database-sqlite.json   # 数据库配置文件示例(SQLite)
├── frontend                           # 前端目录
│   ├── static                         # 静态文件目录
│   │   ├── ...                        # 自定义静态文件(css,js,image)
│   │   ├── apps                       # 应用前端
│   │   │   ├── ...                    # 其他子应用前端-静态文件
│   │   │   └── home                   # home子应用-前端-静态文件
│   │   └── _libs                      # 第三方库
│   ├── templates                      # 模板目录
│   │   ├── ...                        # 各子应用模板
│   │   ├── home                       # home子应用-前端-模板文件
│   │   └── base-layout.html           # 基础父模板
│   ├── favicon.ico                    # 站点图标(ICO)
│   ├── favicon.png                    # 站点图标(PNG)
│   ├── flask-bigger.png               # LOGO(PNG)
│   └── robots.txt                     # 搜索引擎配置文件
├── .gitignore                         # Git忽略文件
├── deploy.py                          # 部署-启动文件
├── LICENSE                            # 许可证(MIT)
├── manage.py                          # 命令行操作脚本(数据库操作)
├── README.md                          # 项目说明
├── requirements.txt                   # 依赖包清单文件
├── run.py                             # 开发运行-启动文件
└── site.version                       # 站点版本文件