# FlaskMixAPP

**Repository Path**: guanfuchang/FlaskMixAPP

## Basic Information

- **Project Name**: FlaskMixAPP
- **Description**: Flask 混合APP项目开发骨架/定时任务系统task_app
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-11-22
- **Last Updated**: 2023-03-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## FlaskMixAPP
使用Flask开发服务端服务，不断优化后形成的一套**项目混合结构**

### 附带APP
- demo_app: 仅包含基础项目结构，用作参考插入新app。
  
- task_app: 定时任务-API调度系统，初始包含该APP原因：在各种项目中，通常都有会一些后台异步的定时任务。

## 安装运行
```cmd
git clone xxxx
cd FlaskMixAPP
pip install -r requirements.txt
flask initdb --drop
flask run
```


## 项目结构
### 结构图
### 项目树
```shell
C:.
│  .flaskenv
│  app.py             # 项目运行入口（重要！！！）
│  config.py          # 项目公共APP配置
│  README.md          # 项目说明
│  requirements.txt   # 项目依赖
│  settings.py        # 项目全局变量
│  
│      
├─commons             # 通用工具模块
│    log.py               # 日志模块
│    __init__.py
│ 
├─logs                # 日志存放目录
│          
├─demo_app
│  │  # 略，同下task_app
│      
├─task_app            # 任务APP
│  │  __init__.py         # APP初始化（重要！！！）
│  │  blueprints.py       # 注册蓝图
│  │  commands.py         # 注册命令    
│  │  extensions.py       # 注册第三方扩展
│  │  models.py           # 数据库定义ORM
│  │  config.py           # APP 配置
│  │  
│  ├─docs
│  │      cron-task.postman_collection.json    #postman 接口集
│  │      
│  ├─tasks
│  │  │  offlineTaskDemo.py                   # 离线测试脚本demo
│  │  │  __init__.py
│  │  │  
│  │          
│  ├─views                # views 视图
│  │  │  job.py 
│  │  │  __init__.py
│          
├─venv  
```


## 添加新的APP
1. 参照dc_app 或 task_app 的项目结构编写APP
2. 在项目根目录中的app.py 中初始化APP
参考如下：
   
```python
from flask import Flask
import demo_app  # 导入APP


def create_app(config_name=None):
    app = Flask(__name__)
    ...
    # app初始化(私)
    app = demo_app.init_app(app, config_name)  # 初始化APP配置
    ...
    return app

```