wemake-django-template 使用教程

1. 项目的目录结构及介绍

wemake-django-template 项目提供了一个完整的 Django 项目模板，其目录结构如下：

wemake-django-template/
├── .cookiecutter
│   └── cookiecutter.json
├── .dockerignore
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .pre-commit-config.yaml
├── docker-compose.yml
├── environment.yml
├── gitlab-ci.yml
├── poeetry.lock
├── pyproject.toml
├── README.md
├── requirements
│   ├── base.txt
│   ├── dev.txt
│   └── prod.txt
├── src/
│   ├── manage.py
│   ├── requirements
│   │   └── __init__.py
│   ├── wemake_django_template/
│   │   ├── __init__.py
│   │   ├── settings/
│   │   │   ├── __init__.py
│   │   │   ├── base.py
│   │   │   ├── dev.py
│   │   │   ├── local.py
│   │   │   └── prod.py
│   │   ├── urls.py
│   │   └── wsgi.py
│   └── apps/
├── tests/
│   └── __init__.py
└── tutorials/

主要目录和文件说明：

• src/: 存放项目的源代码，包括 Django 应用和 manage.py 文件。
• src/wemake_django_template/: 项目的根应用目录，包含了项目的 settings、urls 和 wsgi 文件。
• tests/: 存放测试代码的目录。
• docker-compose.yml: 定义了 Docker 容器的配置，用于开发、测试和生产环境。
• gitlab-ci.yml: 配置了 GitLab CI/CD 的流水线，用于自动化测试和部署。
• requirements/: 包含不同环境下的依赖文件。
• README.md: 项目的说明文件。

2. 项目的启动文件介绍

项目的启动文件是 src/manage.py，它是一个标准的 Django 项目管理脚本，用于运行各种 Django 命令，如启动开发服务器、运行测试等。

启动开发服务器的命令如下：

python src/manage.py runserver

这将在默认的8000端口上启动一个本地服务器。

3. 项目的配置文件介绍

项目的配置文件位于 src/wemake_django_template/settings/ 目录下，其中包括以下文件：

• base.py: 包含所有环境共享的设置。
• dev.py: 开发环境的特定设置。
• local.py: 本地开发的特定设置，通常用于开发者的机器。
• prod.py: 生产环境的特定设置。

这些配置文件通过 DJANGO_SETTINGS_MODULE 环境变量来指定哪个配置文件被使用。在开发过程中，通常使用 local.py 或 dev.py，而在生产环境中使用 prod.py。

例如，要使用开发环境的配置，可以设置环境变量如下：

export DJANGO_SETTINGS_MODULE='wemake_django_template.settings.dev'

然后，可以像平常一样运行 Django 命令。