Veniqa 项目教程

1. 项目的目录结构及介绍

Veniqa/
├── setup-resources/
│   └── sendgrid_email_templates/
├── shopping-server/
├── shopping-webclient/
├── management-server/
├── management-webclient/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── docker-compose.yml
└── package.json

目录结构介绍

• setup-resources/: 包含项目设置所需的资源文件，如 sendgrid_email_templates/ 目录下的邮件模板。
• shopping-server/: 购物应用的后端服务代码。
• shopping-webclient/: 购物应用的前端客户端代码。
• management-server/: 管理应用的后端服务代码。
• management-webclient/: 管理应用的前端客户端代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• CHANGELOG.md: 项目更新日志文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• docker-compose.yml: Docker 配置文件，用于定义和运行多容器 Docker 应用程序。
• package.json: 项目的 npm 配置文件，包含项目的依赖和脚本。

2. 项目的启动文件介绍

启动文件

• shopping-server/index.js: 购物应用的后端启动文件。
• management-server/index.js: 管理应用的后端启动文件。
• shopping-webclient/src/main.js: 购物应用的前端启动文件。
• management-webclient/src/main.js: 管理应用的前端启动文件。

启动步骤

1. 后端服务启动:

   • 进入 shopping-server/ 或 management-server/ 目录。
   • 运行 npm start 或 node index.js 启动服务。

2. 前端客户端启动:

   • 进入 shopping-webclient/ 或 management-webclient/ 目录。
   • 运行 npm run serve 启动开发服务器。

3. 项目的配置文件介绍

配置文件

• docker-compose.yml: 定义了 Docker 容器的配置，包括数据库、后端服务和前端服务的配置。
• package.json: 包含了项目的依赖和脚本配置，如 start、build 等命令。
• .env: 环境变量配置文件，通常用于存储敏感信息和项目配置。

配置示例

docker-compose.yml

version: '3'
services:
  db:
    image: mongo
    ports:
      - "27017:27017"
  shopping-server:
    build: ./shopping-server
    ports:
      - "3000:3000"
  management-server:
    build: ./management-server
    ports:
      - "3001:3001"
  shopping-webclient:
    build: ./shopping-webclient
    ports:
      - "8080:8080"
  management-webclient:
    build: ./management-webclient
    ports:
      - "8081:8081"

package.json

{
  "name": "veniqa",
  "version": "1.0.0",
  "scripts": {
    "start": "node index.js",
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build"
  },
  "dependencies": {
    "express": "^4.17.1",
    "vue": "^2.6.11",
    "mongoose": "^5.9.10"
  }
}

.env

MONGO_URI=mongodb://localhost:27017/veniqa
PORT=3000

通过以上配置文件，可以轻松启动和管理 Veniqa 项目。