Merry Maker 项目教程

Merry Maker 项目教程

mmk-ui-api UI, API, and Scanner (Rules Engine) services for Merry Maker 项目地址: https://gitcode.com/gh_mirrors/mm/mmk-ui-api

1. 项目目录结构及介绍

mmk-ui-api/
├── backend/
│   ├── src/
│   ├── package.json
│   ├── yarn.lock
│   └── ...
├── frontend/
│   ├── src/
│   ├── package.json
│   ├── yarn.lock
│   └── ...
├── scanner/
│   ├── src/
│   ├── package.json
│   ├── yarn.lock
│   └── ...
├── docs/
│   ├── README.md
│   └── ...
├── docker-compose.yml
├── docker-compose.all.yml
├── LICENSE.txt
├── README.md
└── ...

目录结构介绍

• backend/: 后端API服务目录，包含源代码、依赖配置文件等。
• frontend/: 前端Vue开发目录，包含源代码、依赖配置文件等。
• scanner/: 扫描器服务目录，包含源代码、依赖配置文件等。
• docs/: 项目文档目录，包含README等文档文件。
• docker-compose.yml: Docker Compose配置文件，用于启动项目所需的服务。
• docker-compose.all.yml: 包含所有服务的Docker Compose配置文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目主文档文件。

2. 项目启动文件介绍

后端启动文件

• backend/package.json: 后端项目的依赖配置文件，包含启动命令。
• backend/src/index.js: 后端服务的入口文件，负责启动API服务。

前端启动文件

• frontend/package.json: 前端项目的依赖配置文件，包含启动命令。
• frontend/src/main.js: 前端Vue应用的入口文件，负责启动前端服务。

扫描器启动文件

• scanner/package.json: 扫描器项目的依赖配置文件，包含启动命令。
• scanner/src/index.js: 扫描器服务的入口文件，负责启动扫描服务。

3. 项目的配置文件介绍

Docker Compose 配置文件

• docker-compose.yml: 基础的Docker Compose配置文件，定义了项目所需的基础服务。
• docker-compose.all.yml: 包含所有服务的Docker Compose配置文件，用于一次性启动所有服务。

后端配置文件

• backend/package.json: 后端项目的依赖配置文件，包含启动命令和依赖包信息。
• backend/.env: 后端环境变量配置文件，用于配置数据库连接、端口等信息。

前端配置文件

• frontend/package.json: 前端项目的依赖配置文件，包含启动命令和依赖包信息。
• frontend/.env: 前端环境变量配置文件，用于配置API地址、端口等信息。

扫描器配置文件

• scanner/package.json: 扫描器项目的依赖配置文件，包含启动命令和依赖包信息。
• scanner/.env: 扫描器环境变量配置文件，用于配置扫描规则、端口等信息。

通过以上配置文件和启动文件，可以方便地启动和管理Merry Maker项目的各个服务。

mmk-ui-api UI, API, and Scanner (Rules Engine) services for Merry Maker 项目地址: https://gitcode.com/gh_mirrors/mm/mmk-ui-api