# lumiyn-code

**Repository Path**: lumiyn/lumiyn-code

## Basic Information

- **Project Name**: lumiyn-code
- **Description**: 基于pnpm workspace的monorepo项目脚手架，技术栈为NESTJS+VUE3全栈。具备完备基础功能的项目初始化脚手架，实现快速开发。
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-07-25
- **Last Updated**: 2025-12-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Lumiyn Monorepo

基于 Vite + TypeScript + Vue3 前端和 NestJS 微服务架构的 Monorepo 项目。

## 项目结构

```
lumiyn/
├── apps/                                   # 前端应用
│   └── web-app/                           # Vue3 前端应用
├── services/                               # 后端微服务
│   ├── gateway/                           # API网关服务
│   └── user-service/                      # 用户服务
├── libs/                                   # 前后端共享函数库
│   └── shared/                            # 共享工具库
├── docs/                                   # 项目文档
├── package.json                            # 根目录package.json
└── pnpm-workspace.yaml                     # 工作空间配置
```

## 技术栈

### 前端
- **Vue 3** - 渐进式JavaScript框架
- **TypeScript** - 类型安全的JavaScript
- **Vite** - 下一代前端构建工具
- **Vue Router** - 官方路由管理器
- **Pinia** - 状态管理库
- **ESLint + Prettier** - 代码规范和格式化

### 后端
- **NestJS** - 渐进式Node.js框架
- **TypeScript** - 类型安全的JavaScript
- **Microservices** - 微服务架构
- **API Gateway** - API网关模式

### 工具
- **pnpm** - 高效的包管理器
- **Monorepo** - 单一仓库管理多个项目

## 快速开始

### 1. 安装依赖
```bash
pnpm install
```

### 2. 开发模式
```bash
# 启动所有服务
pnpm dev

# 单独启动前端
pnpm --filter web-app dev

# 单独启动网关服务
pnpm --filter gateway dev

# 单独启动用户服务
pnpm --filter user-service dev
```

### 3. 构建项目
```bash
# 构建所有项目
pnpm build

# 单独构建项目
pnpm --filter web-app build
```

### 4. 运行测试
```bash
# 运行所有测试
pnpm test

# 运行特定项目测试
pnpm --filter web-app test
```

## 开发指南

### 添加新服务
1. 在 `services/` 目录下创建新服务
2. 使用 NestJS CLI 初始化项目
3. 在 `pnpm-workspace.yaml` 中确认包含路径

### 添加新应用
1. 在 `apps/` 目录下创建新应用
2. 使用 Vue CLI 或 Vite 初始化项目
3. 在 `pnpm-workspace.yaml` 中确认包含路径

### 共享库开发
1. 在 `libs/shared/` 中开发共享代码
2. 使用 `pnpm --filter @lumiyn/shared build` 构建
3. 在其他项目中通过 `@lumiyn/shared` 引用

## 环境变量

每个服务都有自己的环境变量配置：

### 前端应用
- `.env.development` - 开发环境
- `.env.production` - 生产环境

### 后端服务
- `.env` - 通用配置
- `.env.development` - 开发环境
- `.env.production` - 生产环境

## 贡献指南

1. Fork 项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request

## 许可证

MIT License