# flaskdemo

**Repository Path**: xyy010/flaskdemo

## Basic Information

- **Project Name**: flaskdemo
- **Description**: 基于Python Flask的用于快速开发部署的脚手架，包含路由、数据库orm操作、redis缓存操作、全链路追踪等功能。
- **Primary Language**: Python
- **License**: CC0-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-11
- **Last Updated**: 2024-06-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FLASK DEMO

#### 介绍
基于Python Flask的用于快速开发部署的脚手架，包含路由、数据库orm操作、redis缓存操作、全链路追踪、日志记录等功能。

#### 本地安装教程

1.  安装Python 3.12.3、mysql、redis
2.  执行mysql脚本：./script/init.sql
3.  安装依赖：pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt
4.  修改config.py中的数据库连接信息及redis连接信息
5.  启动服务：python -m flask --app start run -h 0.0.0.0 -p 8080
6.  访问：http://localhost:8080/xxxxx  (xxxxx为具体的路由，参看./app/routes/example.py)

#### docker安装构建

1.  构建python基础镜像，用于后续相同python环境的构建，Dockerfile参看:./script/python_baseimg_Dockerfile；
2.  根据实际环境修改uwsgi.ini文件，拷贝../flaskdemo/ 到镜像服务器目录；
3.  构建flaskdemo镜像，Dockerfile参看:Dockerfile，其中基础镜像根据1中构建的镜像修改，构建命令：docker build -t flask-demo:0.0.1 .
4.  启动容器：docker run -p 9190:9190 -e "DATABASE_URI=修改为实际的数据库连接信息" -e "REDIS_URL=修改为实际的redis连接信息" -itd flask-demo:0.0.1
5.  访问：http://HOST_IP:9190/xxxxx  (xxxxx为具体的路由，参看./app/routes/example.py)

#### 目录结构说明

1.  app/  应用目录，包含应用的主要代码;
2.  config.py  应用配置，包含数据库连接信息、redis连接信息等;
3.  script/  应用辅助脚本目录;
4.  requirements.txt  应用依赖;
5.  uwsgi.ini  uWSGI配置文件，用于通过uWSGI启动flask应用;
6.  Dockerfile  用于构建flaskdemo镜像的Dockerfile文件;
7.  start.py  用于flask应用启动的入口文件;
8.  dbnx.py  数据库表实体逆向生成工具。

### 参与贡献
1.  Fork 本仓库 develop 分支
2.  基于 develop 分支新建 develop_xxx 分支
3.  提交代码到 develop_xxx 分支
4.  新建 develop_xxx 分支到 develop 分支的 Pull Request