# 根目录

根目录即工程目录,对应脚手架工具中的项目名称选项。

这个目录应该是一个有效的 Python 工程目录,设立了 源码(应用)文件夹、测试文件夹、项目配置文件等等,让我们来一起看下项目根目录的构成

根目录

针对这几个文件/文件夹,简略的说明在此:

.
├── {{flask-app-name}}        -- 应用(源码)文件夹,Flask项目核心代码,以Flask名称命名; 原 app 文件夹
├── deploy                    -- 部署相关的命令与脚本,目前主要保存 gunicorn 的配置
├── docker                    -- 和docker有关的文件,一般是DockerFile的栖息地,模板提供了统一的 build 脚本
├── venv                      -- 项目使用的虚拟环境,可以通过 run.sh 脚本来创建,这个已经被添加在 .gitignore
|                                中,因此提交时会被忽略
├── migrations                -- 数据库迁移环境与目录
├── requirements              -- 项目依赖文件, 其中,requirements.txt是代码的运行环境,
|                                而requirements-dev.txt则是我们本地开发额外需要的环境
├── test                      -- 单元测试的家
├── README.md                 -- 项目说明文件
├── pyproject.toml            -- 项目配置文件; 原 setup.cfg 文件
├── run.py                    -- 代码调试入口
├── run.sh                    -- 代码运行、初始化入口
├── .gitignore                -- 根据github的python仓库`.gitignore`修改,绝大多数情况下不需要改
├── .gitlab-ci.yml            -- cicd 脚本文件
├── .pre-commit-config.yaml   -- pre-commit 配置文件
└── .dockerignore             -- docker-ignore 配置文件