Create guanghu-project module file structure
Co-authored-by: qinfendebingshuo <207279273+qinfendebingshuo@users.noreply.github.com>
This commit is contained in:
parent
43e8e6f1d3
commit
9a247a55fb
|
|
@ -0,0 +1,32 @@
|
|||
name: 模块结构检查
|
||||
on: [push, pull_request]
|
||||
jobs:
|
||||
check:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: 检查模块结构
|
||||
run: |
|
||||
MODULES="m01-login m03-personality m05-user-center m06-ticket m07-dialogue-ui m10-cloud m11-module m12-kanban dingtalk-bot backend-integration"
|
||||
ERRORS=0
|
||||
for mod in $MODULES; do
|
||||
if [ -d "$mod" ]; then
|
||||
if [ ! -f "$mod/README.md" ]; then
|
||||
echo "❌ $mod 缺少 README.md"
|
||||
ERRORS=$((ERRORS+1))
|
||||
fi
|
||||
if [ ! -f "$mod/package.json" ]; then
|
||||
echo "⚠️ $mod 缺少 package.json(环节1前需补充)"
|
||||
fi
|
||||
if [ ! -d "$mod/src" ]; then
|
||||
echo "⚠️ $mod 缺少 src/ 目录(环节1前需补充)"
|
||||
fi
|
||||
fi
|
||||
done
|
||||
if [ $ERRORS -gt 0 ]; then
|
||||
echo "结构检查未通过,请修复以上问题"
|
||||
exit 1
|
||||
fi
|
||||
echo "✅ 所有模块结构检查通过"
|
||||
55
README.md
55
README.md
|
|
@ -1,36 +1,27 @@
|
|||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
# 光湖系统 · 模块代码总仓库
|
||||
|
||||
## Getting Started
|
||||
## 仓库结构
|
||||
每个模块一个文件夹,开发者将代码上传到对应文件夹中。
|
||||
|
||||
First, run the development server:
|
||||
| 文件夹 | 模块 | 负责人 |
|
||||
|--------|------|--------|
|
||||
| m01-login | M01 用户登录界面 | 肥猫 |
|
||||
| m03-personality | M03 人格系统 | 肥猫 |
|
||||
| m05-user-center | M05 用户中心界面 | 花尔 |
|
||||
| m06-ticket | M06 工单管理界面 | 桔子 |
|
||||
| m07-dialogue-ui | M07 对话UI | 燕樊 |
|
||||
| m10-cloud | M10 云盘系统 | 燕樊 |
|
||||
| m11-module | M11 工单管理模块 | 桔子 |
|
||||
| m12-kanban | M12 状态看板 | 小草莓 |
|
||||
| dingtalk-bot | 钉钉机器人 | 之之 |
|
||||
| backend-integration | 后端集成中间层 | 页页 |
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
## 上传规范
|
||||
每个模块文件夹必须包含以下文件:
|
||||
- README.md(模块说明)
|
||||
- package.json(依赖声明)
|
||||
- src/(源代码目录)
|
||||
- SYSLOG.md(开发回执日志)
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
## 自动检查
|
||||
每次 push 会自动检查模块结构是否符合规范,不通过会标红提醒。
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
# 后端集成中间层
|
||||
- 负责人:页页
|
||||
- 状态:进行中
|
||||
- 技术栈:Node.js
|
||||
- 依赖模块:所有前端模块
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# 钉钉机器人
|
||||
- 负责人:之之
|
||||
- 状态:环节0已完成
|
||||
- 技术栈:Node.js + Express
|
||||
- 依赖模块:无
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M01 用户登录界面
|
||||
- 负责人:肥猫
|
||||
- 状态:进行中
|
||||
- 技术栈:待定
|
||||
- 依赖模块:无
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M03 人格系统
|
||||
- 负责人:肥猫
|
||||
- 状态:进行中
|
||||
- 技术栈:待定
|
||||
- 依赖模块:M01
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M05 用户中心界面
|
||||
- 负责人:花尔
|
||||
- 状态:环节0
|
||||
- 技术栈:HTML/CSS/JS
|
||||
- 依赖模块:无
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M06 工单管理界面
|
||||
- 负责人:桔子
|
||||
- 状态:环节0
|
||||
- 技术栈:HTML/CSS/JS
|
||||
- 依赖模块:无
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M07 对话UI
|
||||
- 负责人:燕樊
|
||||
- 状态:进行中
|
||||
- 技术栈:待定
|
||||
- 依赖模块:无
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M10 云盘系统
|
||||
- 负责人:燕樊
|
||||
- 状态:等待SYSLOG
|
||||
- 技术栈:待定
|
||||
- 依赖模块:无
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M11 工单管理模块
|
||||
- 负责人:桔子
|
||||
- 状态:进行中
|
||||
- 技术栈:待定
|
||||
- 依赖模块:M06
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# M12 状态看板
|
||||
- 负责人:小草莓
|
||||
- 状态:进行中
|
||||
- 技术栈:待定
|
||||
- 依赖模块:无
|
||||
Loading…
Reference in New Issue