docs: update README.md
This commit is contained in:
73
README.md
73
README.md
@@ -1,10 +1,10 @@
|
||||
# Helios EVCS - EV Charging Station Management System
|
||||
# Helios EVCS
|
||||
|
||||
*这是一个毕业设计项目,旨在提供一个完整的电动汽车充电站管理系统(EV Charging Station Management System)。*
|
||||
_这是一个毕业设计项目,旨在尝试实现一个完整的电动汽车充电站管理系统(EV CSMS)和配套的演示用充电桩终端。_
|
||||
|
||||
## 📋 项目概述
|
||||
|
||||
Helios EVCS 是一个全栈解决方案,用于管理和监控电动汽车充电基础设施。项目包含后端 CSMS(充电管理系统)和前端 Web 应用。
|
||||
Helios EVCS 是一个全栈解决方案,用于管理和监控电动汽车充电基础设施。项目包含后端 CSMS(充电管理系统)和前端 Web 云平台应用。并设计了一个基于 ESP32,演示用的充电桩终端固件和 PCB 设计。
|
||||
|
||||
## 🏗️ 项目结构
|
||||
|
||||
@@ -25,6 +25,7 @@ helios-evcs/
|
||||
## 📦 工作区包
|
||||
|
||||
### `apps/csms` - 充电管理系统后端
|
||||
|
||||
- **技术栈**:Node.js + Hono + TypeScript
|
||||
- **端口**:3001(默认)
|
||||
- **职责**:
|
||||
@@ -35,6 +36,7 @@ helios-evcs/
|
||||
- RESTful API 接口
|
||||
|
||||
### `apps/web` - 前端管理界面(子模块)
|
||||
|
||||
- **技术栈**:Next.js 15 + React 19 + Tailwind CSS
|
||||
- **端口**:3000(默认)
|
||||
- **源仓库**:https://github.com/HoshinoSuzumi/helios
|
||||
@@ -45,11 +47,11 @@ helios-evcs/
|
||||
- 用户管理
|
||||
|
||||
### `hardware/` - 硬件和固件工程
|
||||
|
||||
- **firmware/** - 充电桩微控制器固件代码
|
||||
- 设备驱动实现
|
||||
- 通信协议栈
|
||||
- 实时控制逻辑
|
||||
|
||||
- **pcb-kicad/** - PCB 电路板设计
|
||||
- KiCAD 工程文件
|
||||
- 电路原理图
|
||||
@@ -59,6 +61,7 @@ helios-evcs/
|
||||
## 🚀 快速开始
|
||||
|
||||
### 前置要求
|
||||
|
||||
- Node.js >= 18
|
||||
- pnpm >= 10.18.2
|
||||
|
||||
@@ -83,6 +86,7 @@ pnpm dev:web
|
||||
```
|
||||
|
||||
访问:
|
||||
|
||||
- 前端应用:http://localhost:3000
|
||||
- 后端 API:http://localhost:3001
|
||||
|
||||
@@ -111,16 +115,16 @@ pnpm start:web
|
||||
|
||||
## 📝 Scripts 说明
|
||||
|
||||
| 命令 | 描述 |
|
||||
|------|------|
|
||||
| `pnpm dev` | 启动所有服务的开发模式 |
|
||||
| `pnpm dev:csms` | 启动后端开发服务器 |
|
||||
| `pnpm dev:web` | 启动前端开发服务器 |
|
||||
| `pnpm build` | 构建所有包 |
|
||||
| `pnpm build:csms` | 构建后端 |
|
||||
| `pnpm build:web` | 构建前端 |
|
||||
| `pnpm start:csms` | 生产环境启动后端 |
|
||||
| `pnpm start:web` | 生产环境启动前端 |
|
||||
| 命令 | 描述 |
|
||||
| ----------------- | ---------------------- |
|
||||
| `pnpm dev` | 启动所有服务的开发模式 |
|
||||
| `pnpm dev:csms` | 启动后端开发服务器 |
|
||||
| `pnpm dev:web` | 启动前端开发服务器 |
|
||||
| `pnpm build` | 构建所有包 |
|
||||
| `pnpm build:csms` | 构建后端 |
|
||||
| `pnpm build:web` | 构建前端 |
|
||||
| `pnpm start:csms` | 生产环境启动后端 |
|
||||
| `pnpm start:web` | 生产环境启动前端 |
|
||||
|
||||
## 🔧 工作区管理
|
||||
|
||||
@@ -162,6 +166,7 @@ git clone --recurse-submodules <repo-url>
|
||||
```
|
||||
|
||||
在子模块内修改后的工作流:
|
||||
|
||||
```bash
|
||||
# 在 apps/web 目录内提交更改
|
||||
cd apps/web
|
||||
@@ -179,53 +184,17 @@ git push
|
||||
## 📚 技术文档
|
||||
|
||||
### 后端开发
|
||||
|
||||
- 详见 `apps/csms/README.md`
|
||||
- Hono 框架文档:https://hono.dev
|
||||
- OCPP 协议规范:https://www.openchargealliance.org
|
||||
|
||||
### 前端开发
|
||||
|
||||
- 详见 `apps/web/README.md`
|
||||
- Next.js 文档:https://nextjs.org/docs
|
||||
- Tailwind CSS:https://tailwindcss.com
|
||||
|
||||
## 🛠️ 环境配置
|
||||
|
||||
### 环境变量
|
||||
|
||||
创建 `.env.local` 文件(根据需要在各包目录下):
|
||||
|
||||
**后端 (`apps/csms/.env.local`):**
|
||||
```env
|
||||
NODE_ENV=development
|
||||
PORT=3001
|
||||
# 其他配置项...
|
||||
```
|
||||
|
||||
**前端 (`apps/web/.env.local`):**
|
||||
```env
|
||||
NEXT_PUBLIC_API_URL=http://localhost:3001
|
||||
# 其他配置项...
|
||||
```
|
||||
|
||||
## 🔒 代码质量
|
||||
|
||||
### ESLint 配置
|
||||
- 使用 Next.js 的 ESLint 规则
|
||||
- 开发时自动检查(可选)
|
||||
|
||||
### TypeScript
|
||||
- 严格模式启用
|
||||
- 所有包使用统一的 TypeScript 版本
|
||||
|
||||
## 📦 发布/部署
|
||||
|
||||
### 构建产物
|
||||
```bash
|
||||
# 构建后的文件位置
|
||||
apps/csms/dist/ # 后端构建输出
|
||||
apps/web/.next/ # 前端构建输出
|
||||
```
|
||||
|
||||
## 👤 作者
|
||||
|
||||
- **Timothy Yin** - master@uniiem.com
|
||||
|
||||
Reference in New Issue
Block a user