# phoenix-function-develop

**Repository Path**: phoenixwing/phoenix-function-develop

## Basic Information

- **Project Name**: phoenix-function-develop
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 3
- **Created**: 2025-11-17
- **Last Updated**: 2026-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Phoenix软件开发评估系统

当前版本：`0.2.0`（2026-07-26）

## 项目概述

本项目用于管理和展示软件开发评估系统的数据，支持从Excel文件导入数据，前端进行增删改查操作，并以多种视图方式展示。

`0.2.0` 完成 Phoenix Wing 工作台集成：Ribbon、页签工作台、左侧 Primary、下方运行日志、Footer 与编辑抽屉统一到同一外壳；业务 API、权限、PostgreSQL 表结构和数据格式保持兼容。

> 📖 **详细需求请查看**: [需求文档.md](./doc/需求文档.md)

## 技术栈

- **后端**: NestJS + TypeScript
- **前端**: Vue 3 + TypeScript + Element Plus
- **工作台**: Phoenix Wing `0.5.1`（Ribbon、Workbench、Primary、日志与编辑抽屉宿主）
- **状态管理**: Pinia（支持持久化）
- **数据格式**: Excel (xlsx) ↔ JSON
- **数据库**: PostgreSQL（`pg` + TypeORM）

## 快速开始

### 环境要求

- Node.js `22.23.1`（支持范围 `>=22.12.0 <23`）
- pnpm `10.15.1`（由根目录 `packageManager` 固定）

### 安装依赖

```bash
# 在工作区根目录安装全部依赖
pnpm install --frozen-lockfile
```

### 初始配置

以 `backend/config/config.example.json` 为模板准备本地配置 JSON；可按部署环境调整后导入。不要将真实凭据提交到仓库。

### 启动项目

```bash
# 同时启动前后端（推荐）
pnpm dev

# 或者分别启动
pnpm dev:backend  # 后端（端口：9201）
pnpm dev:frontend # 前端（端口：9202）
```

### 提交前质量门禁

```bash
# 依次执行前后端类型检查、回归测试和生产构建
pnpm check
```

工作区只以根目录 `pnpm-lock.yaml` 为依赖锁定依据；本地与 CI 使用相同命令，禁止在 `backend`、`frontend` 单独维护锁文件。

同步到 GitHub 并启用 Actions 时，[Pfd Quality Gate](./.github/workflows/PfdQualityGate.yml) 会在推送和合并请求上执行冻结依赖安装与同一套门禁。当前仓库 remote 为 Gitee，远程必需检查需在实际托管平台另行启用。

## 项目结构

```
phoenix-function-develop/
├── backend/          # NestJS 后端服务
├── frontend/         # Vue3 前端应用
├── doc/              # 文档和数据文件
│   ├── README.md     # 📚 文档目录索引（推荐先看）
│   ├── 需求文档.md   # 主需求文档
│   ├── INIT.md       # 项目初始化指南
│   └── ...           # 其他需求文档
└── README.md         # 本文件
```

## 核心功能

- ✅ Excel数据导入和转换
- ✅ 前端数据增删改查（Pinia持久化）
- ✅ 功能列表和全景图
- ✅ 功能标签颜色渲染（按年份）
- ✅ 数据保存（JSON/Excel格式，带日期）
- ✅ 功能详情页面（支持Markdown）
- ✅ 配置管理页面
- ✅ Action操作记录
- ✅ 评估功能（多人评估、采纳评估）
- ✅ PostgreSQL数据库支持
- ✅ Phoenix Wing Ribbon、工作台页签、Primary、日志下栏与 Footer
- ✅ 功能列表/功能卡片统一编辑抽屉及未保存变更保护

> 更多功能详情请查看 [需求文档.md](./doc/需求文档.md)

## 许可与贡献者

项目当前默认采用 [Apache License 2.0](./LICENSE)。著作权及其他依法享有的权利由各贡献者分别保留，`The Phoenix Contributors` / “Phoenix 贡献者”是集合性署名，不表示权利统一归属于某家公司或个人。

历史贡献身份、jzkl 的个人贡献范围以及许可切换前的 AGPL-3.0 状态，见 [PfdAUTHORS.md](./PfdAUTHORS.md) 与 [PfdLICENSE-NOTICE.md](./PfdLICENSE-NOTICE.md)。第三方依赖继续适用各自许可证。

## 📚 文档目录

**👉 [查看完整文档目录](./doc/README.md)**

### 快速导航

- 📖 **[文档目录索引](./doc/README.md)** - 所有文档的索引和快速链接
- 🚀 **[项目初始化指南](./doc/INIT.md)** - 新开发者必读
- 📋 **[主需求文档](./doc/需求文档.md)** - 完整的需求规格说明
- 🗄️ **[数据库初始化指南](./doc/INIT.md)** - PostgreSQL 本地配置、初始化与运行说明
- 🧩 **[Wing 界面改造计划](./doc/PfdWing界面改造简要实施计划.md)** - 已完成的工作台改造范围与验收
- 📝 **[变更记录](./doc/CHANGELOG.md)** - 版本发布与文档更新记录

### 功能文档

- [功能详情需求文档](./doc/功能详情需求文档.md) - 功能详情页面设计
- [外包费用需求文档](./doc/外包费用需求文档.md) - 外包费用功能需求
- [配置管理页面需求](./doc/配置管理页面需求.md) - 配置管理功能需求
- [Action记录表功能需求文档](./doc/Action记录表功能需求文档.md) - Action记录和评估功能
- [配置项编辑组件设计](./doc/配置项编辑组件设计.md) - 组件设计文档