Pengwin 项目启动与配置教程

1. 项目目录结构及介绍

Pengwin 项目采用以下目录结构：

Pengwin/
├── .gitignore       # Git 忽略文件
├── .env             # 环境变量配置文件
├── Dockerfile       # Docker 镜像构建文件
├── README.md        # 项目说明文件
├── requirements.txt # 项目依赖文件
├── manage.py        # 项目管理脚本
├── pengwin/         # 项目核心代码目录
│   ├── __init__.py  # 初始化文件
│   ├── settings.py  # 项目配置文件
│   ├── urls.py      # URL 配置文件
│   ├── wsgi.py      # WSGI 应用文件
│   ├── apps/        # 应用目录
│   │   ├── __init__.py
│   │   ├── admin.py # 管理界面配置文件
│   │   ├── apps.py  # 应用配置文件
│   │   ├── models.py # 模型定义文件
│   │   ├── views.py # 视图函数文件
│   │   ├── static/  # 静态文件目录
│   │   ├── templates/ # 模板文件目录
│   ├── static/      # 项目的静态文件目录
│   └── templates/   # 项目的模板文件目录
└── tests/           # 测试代码目录

• .gitignore：指定在 Git 版本控制中需要忽略的文件。
• .env：存储项目运行时的环境变量。
• Dockerfile：用于构建 Docker 镜像的文件。
• README.md：项目说明文件，介绍了项目的基本信息和使用方法。
• requirements.txt：项目依赖文件，列出了项目运行所需的 Python 库。
• manage.py：Django 管理脚本，用于执行数据库迁移、启动服务器等操作。
• pengwin/：项目核心代码目录。

2. 项目的启动文件介绍

项目的启动文件为 manage.py，位于项目根目录。以下是一些常用的命令：

• 启动开发服务器：

  python manage.py runserver
  

  默认情况下，开发服务器将在 http://127.0.0.1:8000/ 上运行。

• 运行测试：

  python manage.py test
  

• 执行数据库迁移：

  python manage.py migrate
  

3. 项目的配置文件介绍

项目的配置文件为 pengwin/settings.py，该文件包含了项目的各项配置信息。

以下是一些重要的配置项：

• DEBUG：调试模式，开发时设置为 True，部署时设置为 False。
• SECRET_KEY：用于签名内部数据，如会话等，必须保持安全且唯一。
• DATABASES：数据库配置，包括数据库类型、用户名、密码等。
• INSTALLED_APPS：项目中安装的应用列表。
• MIDDLEWARE：中间件配置，用于处理请求和响应。
• TEMPLATES：模板配置，包括模板引擎和模板目录。
• STATIC_URL 和 STATIC_ROOT：静态文件的URL和存储路径。

确保在开始之前正确配置这些选项，以确保项目能够正常运行。