zikai
4334dec00d
README 仅保留概览/结构/基础设施/安装/开发命令； 架构、新增页签、子模块管理细节移至 docs/ 下三个 md： - docs/architecture.md：模块注册/PageShell/KeepAlive/存活校验 - docs/add-module.md：新增页签步骤 + 元数据字段速查 + 常见变体 - docs/submodule-timeTableFix.md：submodule 升级/clone/移除/独立访问
99 lines
4.2 KiB
Markdown
99 lines
4.2 KiB
Markdown
# mainPage · 作品集主页
|
||
|
||
Zikai 的作品集主页 -- Vue 3 模块化多项目展示站。浅色极简、中英双语（英文按需懒加载）。
|
||
每个项目页签是一个独立「模块」，由注册表自动生成页签与路由 -- 新增/删除页签只增删一个文件夹，互不影响。
|
||
|
||
> 架构细节、新增页签指南、子项目管理见 [`docs/`](./docs/)。
|
||
|
||
---
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
mainPage/
|
||
├── index.html
|
||
├── package.json # 含 ical.js（timeTableFix 依赖）
|
||
├── vite.config.js # 构建输出到 /root/html（emptyOutDir=false，不清空既有文件）
|
||
├── .gitmodules # git submodule：third_party/timeTableFix
|
||
├── README.md
|
||
├── docs/ # 架构 / 新增页签 / 子模块管理文档
|
||
├── public/favicon.svg
|
||
├── third_party/
|
||
│ └── timeTableFix/ # ★ git submodule：ICS 日程整理器，独立仓库
|
||
└── src/
|
||
├── main.js # 应用入口（挂载 i18n / router / 全局样式）
|
||
├── App.vue # 根布局：顶栏 + 标签导航 + <KeepAlive router-view> + 页脚
|
||
├── config/
|
||
│ └── app.config.js # 集中配置：外部服务 URL（白板地址 / 存活探针等）
|
||
├── i18n/ # 国际化（中文同步注入；英文动态 import() 懒加载）
|
||
├── router/index.js # 路由表由模块注册表自动生成
|
||
├── modules/ # ★ 扩展点：每个页签一个文件夹
|
||
│ ├── index.js # 注册表（import.meta.glob 约定式收集，带容错）
|
||
│ ├── mobile-game/ # 移动游戏项目页签
|
||
│ ├── whiteboard/ # 共享记事本页签（iframe 嵌入 + 存活校验）
|
||
│ ├── timetable/ # 日程整理页签（构建期 import 子模块 App.vue）
|
||
│ └── calendar/ # 隐藏页（仅手动访问 /cqy）
|
||
├── components/ # 共享组件（TabNav / LanguageSwitcher / ui 基元含 PageShell）
|
||
├── composables/ # useProjects / useLiveness / useI18nLazy / useLocale
|
||
└── styles/ # variables.css（主题令牌）+ base.css
|
||
```
|
||
|
||
## 依赖的基础设施
|
||
|
||
| 项 | 要求 |
|
||
|---|---|
|
||
| Node.js | ≥ 18（开发于 18.19 + npm 9.2） |
|
||
| Web 服务器 | Apache 2.4（启用 `mod_rewrite`），对外静态服务 `/root/html` |
|
||
| SPA 回退 | history 模式需站点根 `.htaccess` 回退到 `index.html`（见下） |
|
||
|
||
> 共享记事本页签 iframe 嵌入外部服务（`https://f.zikai.wang/wb/share`），URL 在 `src/config/app.config.js` 配置。
|
||
> 日程整理页签（timeTableFix）经 git submodule 构建期集成（非 iframe），详见 [`docs/submodule-timeTableFix.md`](./docs/submodule-timeTableFix.md)。
|
||
|
||
## Ubuntu 从 0 安装
|
||
|
||
```bash
|
||
# 1. 安装 Node.js 18
|
||
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo bash -
|
||
sudo apt-get install -y nodejs
|
||
|
||
# 2. 取代码（含子模块 timeTableFix）
|
||
git clone --recursive https://git.zikai.wang/zikai/zMainPage.git mainPage
|
||
cd mainPage
|
||
# 若已 clone 但未带子模块：git submodule update --init --recursive
|
||
npm install
|
||
|
||
# 3. 构建（产物输出到 /root/html，不清空既有文件）
|
||
npm run build
|
||
|
||
# 4. 安装并启用 Apache
|
||
sudo apt-get install -y apache2
|
||
sudo a2enmod rewrite
|
||
```
|
||
|
||
站点根放 `.htaccess`（Apache 需 `AllowOverride All`）做 SPA 回退：
|
||
|
||
```apache
|
||
RewriteEngine On
|
||
RewriteCond %{REQUEST_FILENAME} -f [OR]
|
||
RewriteCond %{REQUEST_FILENAME} -d
|
||
RewriteRule ^ - [L]
|
||
RewriteRule ^ index.html [L]
|
||
```
|
||
|
||
把 `/root/html`（或 `/var/www/html`）设为 `DocumentRoot`，访问站点即可。
|
||
|
||
## 开发命令
|
||
|
||
```bash
|
||
npm install # 首次安装依赖
|
||
npm run dev # 开发服务器 http://localhost:5173
|
||
npm run build # 构建到 /root/html
|
||
npm run preview # 本地预览构建产物
|
||
```
|
||
|
||
## 了解更多
|
||
|
||
- [架构（模块注册 / PageShell / KeepAlive / 存活校验）](./docs/architecture.md)
|
||
- [如何新增一个项目页签](./docs/add-module.md)
|
||
- [子项目 timeTableFix 管理（submodule 升级 / 移除）](./docs/submodule-timeTableFix.md)
|