Initial commit
This commit is contained in:
26
CHANGELOG.md
Normal file
26
CHANGELOG.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# 更新日志 (Changelog)
|
||||
|
||||
本项目的所有显著更改都将记录在此文件中。
|
||||
|
||||
格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/),并且本项目遵循 [Semantic Versioning](https://semver.org/lang/zh-CN/)。
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### 新增
|
||||
- 完善项目文档结构,增加 `CONTRIBUTING.md` 和 `CHANGELOG.md`。
|
||||
- 更新 `README.md` 和 `STARTUP.md`,增加对 Node.js 高版本环境的支持说明。
|
||||
|
||||
### 修复
|
||||
- 修正 `INTERFACE_CONFIG.md` 中关于前端代理配置的描述,使其与代码实际逻辑一致。
|
||||
|
||||
## [1.0.0] - 2023-12-XX
|
||||
|
||||
### 初始发布
|
||||
- **Web 管理端**: 基于 Vue.js + Element UI 的后台管理系统。
|
||||
- **后端服务**: 基于 Django + DRF 的 API 服务。
|
||||
- **移动端**: 微信小程序支持。
|
||||
- **核心功能**:
|
||||
- RBAC 权限管理
|
||||
- 工作流引擎
|
||||
- CRM 客户关系管理
|
||||
- 系统监控与日志
|
||||
35
CONTRIBUTING.md
Normal file
35
CONTRIBUTING.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# 贡献指南 (Contributing Guide)
|
||||
|
||||
感谢你对 GeminiWX 项目感兴趣!我们欢迎任何形式的贡献,包括提交 Bug 报告、改进文档、提出新功能建议或直接提交代码。
|
||||
|
||||
## 1. 提交 Issue
|
||||
|
||||
在提交 Issue 之前,请先搜索现有的 Issues,避免重复提交。
|
||||
|
||||
- **Bug 报告**: 请详细描述 Bug 的重现步骤、预期行为和实际行为,并提供相关的日志或截图。
|
||||
- **功能建议**: 请清晰地描述你想要的功能以及它解决了什么问题。
|
||||
|
||||
## 2. 代码开发规范
|
||||
|
||||
本项目遵循一定的代码规范,请在提交代码前仔细阅读。
|
||||
|
||||
- **详细规范**: 请参考 [admin/specification.md](./admin/specification.md)
|
||||
- **后端 (Python/Django)**: 遵循 PEP 8 规范。
|
||||
- **前端 (Vue.js)**: 遵循 Vue 风格指南,保持代码整洁。
|
||||
|
||||
## 3. 提交 Pull Request (PR)
|
||||
|
||||
1. **Fork** 本仓库到你的个人账号。
|
||||
2. **Clone** 你的 Fork 到本地。
|
||||
3. 创建一个新的分支进行开发:`git checkout -b feature/your-feature-name` 或 `git checkout -b fix/your-bug-fix`。
|
||||
4. 提交你的更改:`git commit -m "feat: add new feature"` (推荐遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范)。
|
||||
5. Push 到你的远程仓库:`git push origin feature/your-feature-name`。
|
||||
6. 在 GitHub 上提交 Pull Request。
|
||||
|
||||
## 4. 开发环境搭建
|
||||
|
||||
请参考 [STARTUP.md](./STARTUP.md) 快速搭建开发环境。
|
||||
|
||||
## 5. 许可证
|
||||
|
||||
参与本项目即表示你同意遵守本项目的开源许可证。
|
||||
@@ -51,7 +51,8 @@ ALLOWED_HOSTS = ['*'] # 允许所有域名访问,生产环境建议修改为
|
||||
```javascript
|
||||
proxy: {
|
||||
'/api': {
|
||||
target: 'http://192.168.5.81:8000', // 目标服务器地址
|
||||
// 目标服务器地址,优先使用环境变量 PROXY_TARGET,默认为 localhost
|
||||
target: process.env.PROXY_TARGET || 'http://127.0.0.1:8000',
|
||||
changeOrigin: true
|
||||
}
|
||||
}
|
||||
|
||||
15
README.md
15
README.md
@@ -91,8 +91,23 @@ geminiWX/
|
||||
2. 安装依赖:
|
||||
```bash
|
||||
npm install
|
||||
# 如果遇到依赖冲突,尝试使用:
|
||||
# npm install --legacy-peer-deps
|
||||
```
|
||||
3. 启动开发服务器:
|
||||
* **Windows (PowerShell)**:
|
||||
```powershell
|
||||
# 如果 Node 版本 >= 17,需要设置 NODE_OPTIONS
|
||||
$env:NODE_OPTIONS="--openssl-legacy-provider"
|
||||
npm run dev
|
||||
```
|
||||
* **Linux / macOS**:
|
||||
```bash
|
||||
# 如果 Node 版本 >= 17
|
||||
export NODE_OPTIONS=--openssl-legacy-provider
|
||||
npm run dev
|
||||
```
|
||||
* **通用**:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
16
STARTUP.md
16
STARTUP.md
@@ -52,7 +52,23 @@
|
||||
|
||||
4. 启动开发服务器:
|
||||
|
||||
> **注意**: 如果你的 Node.js 版本 >= 17,可能会遇到 OpenSSL 相关的错误。请在启动前设置环境变量。
|
||||
|
||||
* **Windows (PowerShell)**:
|
||||
```powershell
|
||||
$env:NODE_OPTIONS="--openssl-legacy-provider"
|
||||
npm run dev
|
||||
```
|
||||
|
||||
* **CMD**:
|
||||
```cmd
|
||||
set NODE_OPTIONS=--openssl-legacy-provider
|
||||
npm run dev
|
||||
```
|
||||
|
||||
* **Linux / macOS**:
|
||||
```bash
|
||||
export NODE_OPTIONS=--openssl-legacy-provider
|
||||
npm run dev
|
||||
```
|
||||
|
||||
|
||||
@@ -46,9 +46,9 @@ JWT认证,可使用simple_history实现审计功能,支持swagger
|
||||
|
||||
安装node.js
|
||||
|
||||
安装依赖包 `npm install --registry=https://registry.npmmirror.com`
|
||||
安装依赖包 `npm install --registry=https://registry.npmmirror.com` (若报错尝试 `--legacy-peer-deps`)
|
||||
|
||||
运行服务 `npm run dev`
|
||||
运行服务 `npm run dev` (Node >= 17 需设置 `NODE_OPTIONS=--openssl-legacy-provider`)
|
||||
|
||||
### nginx
|
||||
本地跑时修改nginx.conf,可显示资源文件
|
||||
|
||||
37
wechat-mini-program/README.md
Normal file
37
wechat-mini-program/README.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# GeminiWX 微信小程序
|
||||
|
||||
## 1. 简介
|
||||
GeminiWX 的移动端入口,提供学员端和部分管理功能。
|
||||
|
||||
## 2. 快速开始
|
||||
|
||||
### 环境准备
|
||||
- 下载并安装 [微信开发者工具](https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html)。
|
||||
|
||||
### 导入项目
|
||||
1. 打开微信开发者工具。
|
||||
2. 选择 **导入项目**。
|
||||
3. 选择 `geminiWX/wechat-mini-program` 目录。
|
||||
4. 设置 **AppID** (若无 AppID 可使用测试号)。
|
||||
|
||||
### 配置接口地址
|
||||
编辑 `config/env.js` 文件:
|
||||
|
||||
```javascript
|
||||
const env = 'development' // 切换 'development' 或 'production'
|
||||
|
||||
const configs = {
|
||||
development: {
|
||||
// 请将此处 IP 修改为你本地后端的 IP 地址 (注意: 小程序模拟器支持 localhost, 但真机调试需要局域网 IP)
|
||||
baseUrl: 'http://127.0.0.1:8000/api'
|
||||
},
|
||||
production: {
|
||||
baseUrl: 'https://your-domain.com/api'
|
||||
}
|
||||
}
|
||||
module.exports = configs[env]
|
||||
```
|
||||
|
||||
## 3. 注意事项
|
||||
- 确保后端服务已启动且网络可达。
|
||||
- 开发环境如果不使用 HTTPS,请在微信开发者工具中勾选 "不校验合法域名、web-view(业务域名)、TLS版本以及HTTPS证书"。
|
||||
Reference in New Issue
Block a user