stminsights 项目启动与配置教程

1. 项目目录结构及介绍

stminsights 项目的目录结构如下：

stminsights/
├── .gitignore          # 指定git应该忽略的文件和目录
├── .vscode/            # Visual Studio Code的配置文件目录
├── Dockerfile          # Docker的自动化构建文件
├── LICENSE             # 项目许可证文件
├── README.md           # 项目说明文件
├──_REQUIREMENTS.txt    # 项目运行所需的Python库依赖
├── config/             # 配置文件目录
│   ├── __init__.py
│   └── settings.py     # 项目配置文件
├── manage.py           # Django的管理脚本，用于数据库迁移等操作
├── project/            # 项目主体代码目录
│   ├── __init__.py
│   ├── settings/       # 项目设置目录
│   │   ├── __init__.py
│   │   ├── base.py     # 基础配置
│   │   ├── dev.py      # 开发环境配置
│   │   └── prod.py     # 生产环境配置
│   ├── urls/           # URL配置目录
│   │   ├── __init__.py
│   │   └── urls.py     # URL路由配置
│   ├── wsgi/           # WSGI配置目录
│   │   ├── __init__.py
│   │   └── wsgi.py     # WSGI应用入口
│   └── apps/           # 应用目录
│       ├── __init__.py
│       └── ...         # 具体应用模块
└── tests/              # 测试代码目录
    ├── __init__.py
    └── ...

• .gitignore：指定在git版本控制中应该忽略的文件和目录，例如编译生成的文件、日志文件等。
• .vscode/：Visual Studio Code的配置文件目录，用于存放代码编辑器的个人设置。
• Dockerfile：定义了如何构建Docker镜像，用于容器的自动化部署。
• LICENSE：开源项目的许可协议文件，说明了项目的版权和使用条款。
• README.md：项目的说明文档，包含项目介绍、安装步骤、使用说明等。
• _REQUIREMENTS.txt：列出了项目依赖的Python包，通过pip工具安装。
• config/：存放项目的配置文件。
• manage.py：Django项目的管理接口，用于执行数据库迁移、创建管理员账户等操作。
• project/：包含项目的核心代码，包括应用模块、URL配置、WSGI配置等。
• tests/：存放测试代码，确保项目功能的正确性和稳定性。

2. 项目的启动文件介绍

项目的启动主要依赖于manage.py文件，以下是该文件的基本使用方法：

• 运行开发服务器：python manage.py runserver 在开发环境中，可以通过这个命令启动Django内置的服务器，通常用于开发和测试。

• 执行数据库迁移：python manage.py migrate 在项目首次运行或数据库结构有变化时，需要执行迁移命令来更新数据库。

• 创建管理员账户：python manage.py createsuperuser 在创建新项目时，需要创建一个管理员账户来管理后台。

3. 项目的配置文件介绍

项目的配置文件位于config/settings.py，以下是配置文件中的几个关键部分：

• DATABASES：数据库配置，包括数据库类型、数据库名称、用户名、密码等。
• ALLOWED_HOSTS：允许的域名列表，用于限制哪些域名可以访问本项目。
• INSTALLED_APPS：安装的应用列表，包括Django内置的应用和本项目开发的应用。
• MIDDLEWARE：中间件配置，Django中的中间件组件可以处理请求和响应，执行如用户认证、会话管理等功能。
• TEMPLATES：模板配置，定义了Django如何加载和渲染模板。
• STATIC_URL和MEDIA_URL：静态文件和媒体文件的URL配置。

根据不同的环境（开发环境、生产环境），可以在base.py的基础上，通过继承和覆盖的方式，创建dev.py和prod.py来定义特定的配置。