# StartSpec

**Repository Path**: cng1985/start-spec

## Basic Information

- **Project Name**: StartSpec
- **Description**: StartSpec - AI 软件需求平台
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-03
- **Last Updated**: 2025-12-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: AI, AI编程, cursor

## README

# StartSpec - AI 软件需求平台

> **创谱 AI** - 帮助非技术创业者与开发团队沟通的智能需求管理平台

## 📖 项目简介

StartSpec 是一个基于 AI 的软件需求管理平台，旨在解决非技术创业者与开发团队之间的沟通鸿沟。通过 AI 扮演"联合创始人"的角色，辅助用户完成从想法验证到需求梳理、原型绘制、成本预估的全过程，最终输出可执行的工程级文档。

### 核心功能

- 🤖 **AI 需求采集** - 基于对话的需求采集与"想法压力测试"
- 🎨 **实时原型生成** - "所见即所得"的实时原型（UI 线框图）生成
- 📄 **文档自动生成** - 自动生成标准 PRD 文档（Markdown/PDF），支持版本管理
- 💰 **成本预估** - 基于功能点的开发工时与预算预估
- 🔍 **竞品分析** - 提供竞品分析与差异化建议
- 📊 **项目管理** - 完整的项目管理和协作功能

## 🛠️ 技术栈

- **框架**: [Nuxt 4](https://nuxt.com/) - Vue.js 全栈框架
- **UI 组件库**: [Element Plus](https://element-plus.org/) - Vue 3 组件库
- **物理引擎**: [Matter.js](https://brm.io/matter-js/) - 2D 物理引擎
- **日期处理**: [Day.js](https://day.js.org/) - 轻量级日期库
- **包管理器**: [pnpm](https://pnpm.io/) - 快速、节省磁盘空间的包管理器

## 📁 项目结构

```
StartSpec/
├── app/                    # 应用主目录
│   ├── assets/            # 静态资源
│   │   └── css/           # 样式文件
│   ├── components/         # Vue 组件
│   │   ├── Footer.vue     # 页脚组件
│   │   └── Navbar.vue    # 导航栏组件
│   ├── composables/        # 组合式函数
│   │   ├── useApi.ts     # API 请求封装
│   │   ├── useAuth.ts    # 认证相关
│   │   └── useToast.ts   # 消息提示
│   ├── middleware/         # 中间件
│   │   └── auth.ts       # 认证中间件
│   ├── pages/              # 页面路由
│   │   ├── index.vue     # 首页
│   │   ├── login.vue     # 登录页
│   │   ├── register.vue  # 注册页
│   │   ├── dashboard/    # 仪表盘
│   │   ├── studio.vue    # 工作室
│   │   ├── blog/         # 博客
│   │   └── ...
│   └── plugins/            # 插件
├── server/                 # 服务端
│   └── api/               # API 路由
│       └── user/          # 用户相关 API
├── doc/                    # 项目文档
│   ├── AI软件需求平台_产品需求文档.md
│   ├── AI软件需求平台_商业计划书.md
│   ├── AI软件需求平台_技术方案.md
│   └── ...
├── public/                 # 公共静态文件
├── nuxt.config.ts          # Nuxt 配置文件
└── package.json            # 项目依赖配置
```

## 🚀 快速开始

### 环境要求

- Node.js >= 18.x
- pnpm >= 9.x (推荐使用项目指定的版本)

### 安装依赖

```bash
# 使用 pnpm (推荐)
pnpm install

# 或使用其他包管理器
npm install
# yarn install
# bun install
```

### 开发环境

启动开发服务器（默认运行在 `http://localhost:3000`）：

```bash
# 使用 pnpm
pnpm dev

# 或使用其他包管理器
npm run dev
# yarn dev
# bun run dev
```

### 生产构建

构建生产版本：

```bash
# 使用 pnpm
pnpm build

# 或使用其他包管理器
npm run build
# yarn build
# bun run build
```

预览生产构建：

```bash
# 使用 pnpm
pnpm preview

# 或使用其他包管理器
npm run preview
# yarn preview
# bun run preview
```

### 静态站点生成

生成静态站点：

```bash
pnpm generate
```

## ⚙️ 配置说明

### 环境变量

在项目根目录创建 `.env` 文件（可选）：

```env
# API 基础地址
NUXT_PUBLIC_API_BASE=https://adminstore.saas.nbsaas.com
```

配置说明：
- `NUXT_PUBLIC_API_BASE`: API 服务的基础地址，默认为 `https://adminstore.saas.nbsaas.com`

### Nuxt 配置

主要配置位于 `nuxt.config.ts`：

- **兼容性日期**: `2025-07-15`
- **开发工具**: 已启用 Nuxt DevTools
- **模块**: Element Plus UI 组件库
- **样式**: 自定义 CSS 文件

## 📚 相关文档

项目详细文档位于 `doc/` 目录：

- [产品需求文档](./doc/AI软件需求平台_产品需求文档.md) - 完整的产品功能需求
- [商业计划书](./doc/AI软件需求平台_商业计划书.md) - 商业模式和计划
- [技术方案](./doc/AI软件需求平台_技术方案.md) - 技术架构和实现方案
- [详细设计](./doc/AI软件需求平台_模块一_详细设计.md) - 模块详细设计
- [界面设计文档](./doc/AI软件需求平台_界面设计文档.md) - UI/UX 设计规范
- [项目开发计划](./doc/AI软件需求平台_项目开发计划.md) - 开发时间表和里程碑

## 🔧 开发指南

### 代码规范

- 使用 TypeScript 进行类型检查
- 遵循 Vue 3 Composition API 最佳实践
- 组件使用 `<script setup>` 语法

### 常用命令

```bash
# 开发模式
pnpm dev

# 构建生产版本
pnpm build

# 生成静态站点
pnpm generate

# 预览生产构建
pnpm preview

# 准备项目（安装后自动运行）
pnpm postinstall
```

### API 使用

项目提供了 `useApi` 组合式函数用于 API 请求：

```typescript
const { request } = useApi()
const data = await request('/api/endpoint', {
  method: 'POST',
  body: { ... }
})
```

### 认证

使用 `useAuth` 组合式函数管理用户认证状态：

```typescript
const { token, user, login, logout } = useAuth()
```

## 📝 许可证

本项目为私有项目。

## 🔗 相关链接

- [Nuxt 文档](https://nuxt.com/docs/getting-started/introduction)
- [Vue 3 文档](https://vuejs.org/)
- [Element Plus 文档](https://element-plus.org/)
- [部署文档](https://nuxt.com/docs/getting-started/deployment)