DongTai 开源项目使用教程
1. 项目的目录结构及介绍
DongTai 项目的目录结构如下:
DongTai/
├── dongtai_engine/
│ ├── Dockerfile
│ ├── Pipfile
│ ├── Pipfile.lock
│ ├── README.md
│ ├── manage.py
│ ├── method_pool.pickle
│ ├── pyproject.toml
│ ├── requirements.txt
│ └── setup.py
├── dongtai_protocol/
│ ├── Dockerfile
│ ├── Pipfile
│ ├── Pipfile.lock
│ ├── README.md
│ ├── manage.py
│ ├── method_pool.pickle
│ ├── pyproject.toml
│ ├── requirements.txt
│ └── setup.py
├── dongtai_web/
│ ├── Dockerfile
│ ├── Pipfile
│ ├── Pipfile.lock
│ ├── README.md
│ ├── manage.py
│ ├── method_pool.pickle
│ ├── pyproject.toml
│ ├── requirements.txt
│ └── setup.py
├── static/
├── test/
├── .dockerignore
├── .gitignore
├── CHANGELOG.md
├── CHANGELOG_CN.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE.txt
├── Pipfile
├── Pipfile.lock
├── README-zh.md
├── README.md
├── SECURITY.md
├── batect
├── batect.cmd
├── batect.yml
├── build_with_docker_compose.sh
└── manage.py
目录结构介绍
dongtai_engine/
: 包含引擎相关的文件和配置。dongtai_protocol/
: 包含协议相关的文件和配置。dongtai_web/
: 包含Web界面相关的文件和配置。static/
: 静态文件目录。test/
: 测试文件目录。.dockerignore
: Docker构建时忽略的文件。.gitignore
: Git版本控制时忽略的文件。CHANGELOG.md
: 项目更新日志。CHANGELOG_CN.md
: 中文项目更新日志。CONTRIBUTING.md
: 贡献指南。Dockerfile
: Docker构建文件。LICENSE.txt
: 项目许可证。Pipfile
: Python依赖管理文件。Pipfile.lock
: Python依赖锁定文件。README-zh.md
: 中文项目说明文档。README.md
: 项目说明文档。SECURITY.md
: 安全相关文档。batect
: 构建工具脚本。batect.cmd
: 构建工具命令行脚本。batect.yml
: 构建工具配置文件。build_with_docker_compose.sh
: Docker Compose构建脚本。manage.py
: 项目管理脚本。
2. 项目的启动文件介绍
启动文件
manage.py
: 这是DongTai项目的主要启动文件,用于管理项目的运行和维护。
启动命令
python manage.py runserver
该命令将启动DongTai的开发服务器,默认运行在http://127.0.0.1:8000/
。
3. 项目的配置文件介绍
配置文件
Pipfile
: 定义了项目的Python依赖包。Pipfile.lock
: 锁定依赖包的版本。Dockerfile
: 定义了Docker镜像的构建过程。batect.yml
: 定义了构建工具的配置。build_with_docker_compose.sh
: 定义了使用Docker Compose构建项目的脚本。
配置示例
Pipfile
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
django = "==3.2.4"
[dev-packages]
[requires]
python_version = "3.8"
Dockerfile
FROM python:3.8-slim
WORKDIR /app
COPY Pipfile Pipfile.