PwnDoc 项目安装与使用教程

1. 项目目录结构及介绍

PwnDoc 项目的目录结构如下：

pwndoc/
├── backend/
├── demos/
├── docs/
├── frontend/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── SECURITY.md
├── docker-compose.yml
└── run_tests.sh

目录介绍：

• backend/：包含项目的后端代码。
• demos/：包含项目的演示文件。
• docs/：包含项目的文档文件。
• frontend/：包含项目的前端代码。
• .gitignore：Git 忽略文件配置。
• CHANGELOG.md：项目更新日志。
• LICENSE：项目许可证文件。
• README.md：项目介绍和使用说明。
• SECURITY.md：项目安全相关说明。
• docker-compose.yml：Docker 配置文件，用于启动项目。
• run_tests.sh：测试脚本。

2. 项目启动文件介绍

PwnDoc 项目的启动主要依赖于 docker-compose.yml 文件。以下是该文件的简要介绍：

version: '3.7'
services:
  backend:
    image: pwndoc/backend
    ports:
      - "8080:8080"
    volumes:
      - ./backend:/app
    depends_on:
      - db

  frontend:
    image: pwndoc/frontend
    ports:
      - "3000:3000"
    volumes:
      - ./frontend:/app

  db:
    image: postgres:12
    environment:
      POSTGRES_USER: pwndoc
      POSTGRES_PASSWORD: pwndoc
      POSTGRES_DB: pwndoc
    volumes:
      - db_data:/var/lib/postgresql/data

volumes:
  db_data:

启动步骤：

1. 确保已安装 Docker 和 Docker Compose。
2. 在项目根目录下运行以下命令启动项目：

   docker-compose up
   

3. 项目启动后，可以通过 http://localhost:3000 访问前端界面，通过 http://localhost:8080 访问后端服务。

3. 项目配置文件介绍

PwnDoc 项目的主要配置文件是 docker-compose.yml，该文件定义了项目的各个服务及其配置。以下是一些关键配置项的介绍：

docker-compose.yml 配置项：

• version: Docker Compose 文件版本。
• services: 定义了项目的各个服务，包括 backend、frontend 和 db。
  • backend: 后端服务配置，包括端口映射、依赖项等。
  • frontend: 前端服务配置，包括端口映射、依赖项等。
  • db: 数据库服务配置，包括数据库用户、密码、数据库名称等。
• volumes: 定义了数据卷，用于持久化存储数据库数据。

其他配置文件：

• .env: 环境变量配置文件，用于设置项目的环境变量。
• config.json: 项目配置文件，用于设置项目的各种参数。

通过以上配置文件，可以灵活地调整项目的运行环境和参数，以满足不同的需求。