jiebanke/README.md

🏗️ 结伴客项目

📋 项目概述

结伴客是一个综合性的管理系统，包含后台管理、微信小程序和官方网站三个主要模块。

🗂️ 项目结构

jiebanke/
├── 📁 backend/           # 后端服务 (Node.js + Express)
├── 📁 admin-system/      # 后台管理系统 (Vue 3 + Element Plus)
├── 📁 website/           # 官方网站 (Vue 3)
├── 📁 mini-program/      # 微信小程序矩阵 (原生小程序)
├── 📁 docs/              # 项目文档
├── 📁 scripts/           # 工具脚本
├── 📁 test/              # 测试文件目录
└── 📄 README.md          # 项目说明 (当前文件)

🚀 快速开始

环境要求

• Node.js 16.x+
• MySQL 8.0+
• npm 8.x+

安装依赖

# 安装后端依赖
cd backend && npm install

# 安装后台管理依赖  
cd admin-system && npm install

# 安装官网依赖
cd website && npm install

# 安装小程序依赖
cd mini-program && npm install

启动开发环境

# 启动后端服务
cd backend && npm run dev

# 启动后台管理 (新终端)
cd admin-system && npm run dev

# 启动官方网站 (新终端)
cd website && npm run dev

📖 项目文档

所有详细文档位于 docs/ 目录：

• 📄 架构设计 - 系统架构和技术栈
• 📄 API文档 - 完整的API接口说明
• 📄 部署指南 - 开发、测试、生产环境部署
• 📄 数据库设计 - 数据库表结构和关系
• 📄 需求文档 - 业务需求和功能说明
• 📄 详细设计 - 系统详细设计方案
• 📄 开发计划 - 项目开发进度计划

🛠️ 开发工具

脚本工具

项目提供了一些有用的开发脚本：

# 数据库连接测试
cd backend && npm run test-db

# API接口测试  
cd backend && npm run test-api

# 数据库初始化
cd backend && npm run db:reset

# 部署脚本 (Linux/Mac)
cd scripts && ./deploy.sh all

# 部署脚本 (Windows PowerShell)
cd scripts && .\deploy.ps1 all

环境配置

复制环境变量模板并配置：

# 后端环境配置
cp backend/.env.example backend/.env

# 后台管理环境配置  
cp admin-system/.env.example admin-system/.env

☁️ 部署

项目支持多种部署方式：

自动部署脚本

在 scripts/ 目录中提供了自动部署脚本，支持 Linux/Mac 和 Windows 系统：

# Linux/Mac 部署所有模块
cd scripts && chmod +x deploy.sh && ./deploy.sh all

# Windows PowerShell 部署所有模块
cd scripts && .\deploy.ps1 all

支持的部署选项：

• all - 部署所有模块
• backend - 部署后端服务
• admin - 部署后台管理系统
• website - 部署官方网站
• mini-program - 构建微信小程序

Docker 容器化部署

每个模块都提供了 Docker 配置文件，可以使用 docker-compose 进行部署：

# 启动所有服务
docker-compose up -d

# 启动指定服务
docker-compose up -d backend

# 查看服务状态
docker-compose ps

手动部署

每个模块也可以手动部署到服务器，具体说明请参考各模块目录中的 DEPLOYMENT.md 文件。

🌐 访问地址

• 后端API: https://webapi.jiebanke.com
• 后台管理: https://admin.jiebanke.com
• 官方网站: https://www.jiebanke.com
• 小程序: 使用微信开发者工具打开 mini-program/ 目录

📦 依赖管理

主要技术栈

后端:

• Node.js + Express.js
• Sequelize ORM
• JWT 认证
• MySQL 数据库

前端:

• Vue 3 + TypeScript
• Element Plus UI
• Vite 构建工具
• Pinia 状态管理

小程序:

• 微信原生小程序
• Vant Weapp UI
• Uni-app 框架

🔧 开发规范

代码风格

• 使用 ESLint + Prettier 统一代码风格
• 遵循 Git Commit 消息规范
• 实行代码审查流程

分支策略

• 采用 Git Flow 工作流
• 功能分支开发
• 发布分支管理

🚀 部署说明

详细部署指南请参考 DEPLOYMENT.md，包含：

• 开发环境部署
• 测试环境部署
• 生产环境部署
• 容器化部署 (Docker)
• 安全配置指南

📞 支持与维护

开发团队

• 后端开发: backend@jiebanke.com
• 前端开发: frontend@jiebanke.com
• 小程序开发: miniprogram@jiebanke.com

运维支持

• 运维团队: ops@jiebanke.com
• 紧急联系: +86-138-0013-8000

📊 版本信息

• 当前版本: v1.0.0
• Node.js: 16.20.2
• Vue: 3.3.4
• MySQL: 8.0.33

---

最后更新: 2024年 📅