# shiguang

**Repository Path**: izunaRen/shiguang

## Basic Information

- **Project Name**: shiguang
- **Description**: 一款计划APP
- **Primary Language**: TypeScript
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-16
- **Last Updated**: 2026-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 拾光计划（shiguang）

> 一款轻量、纯粹的移动端计划 / 待办（Todo）应用。无需注册、无需服务端，全部数据保存在浏览器本地。

## 项目简介

拾光计划围绕「分组 + 任务」组织日常待办，支持单次与周期性任务（每天 / 每周 / 每月 / 每年 / 工作日），配合日历视图、中国法定节假日判断、CSV 导入导出等能力，帮助用户轻松管理日常计划。

技术栈：**Vue 3（组合式 API） + TypeScript + Vite + Pinia + Vant 4**，数据通过 `localStorage` 持久化，可完全离线使用。

## 功能特性

- 📅 **今日待办**：按分组展示当天任务，一键勾选完成
- 🗓 **日历视图**：月历上标注任务分布，点击日期查看 / 新增当日任务
- 🔁 **周期任务**：支持每天、每周、每月、每年、每个工作日 5 种重复规则；可按需配置结束日期、每周星期几、每月几号、每年几月几日；周期任务按「日期」单独记录完成状态
- ⏰ **提醒设置**：支持不提醒 / 到点提醒 / 提前 15 分钟 / 提前 1 小时
- 🎨 **分组管理**：自定义分组名称与颜色，按分组归类任务，删除分组时级联清理其下任务
- 🏖 **节假日感知**：内置中国法定节假日与调休数据，「每个工作日」任务自动跳过节假日、考虑调休补班
- 💾 **本地存储**：数据保存在浏览器 LocalStorage，无后端依赖，可离线使用
- 📤 **CSV 导入导出**：一键导出备份、下载导入模板、按模板批量导入任务
- 📱 **移动优先**：适配手机窄屏与桌面宽屏，基于 Vant 移动组件库

## 技术栈

| 分类       | 技术                                 |
| ---------- | ------------------------------------ |
| 框架       | Vue 3（`<script setup>` 组合式 API） |
| 语言       | TypeScript                           |
| 构建工具   | Vite                                 |
| 状态管理   | Pinia                                |
| 路由       | Vue Router                           |
| UI 组件    | Vant 4（按需自动引入）               |
| 样式       | SCSS（全局变量 + Mixin）             |
| 移动端能力 | Capacitor（预留原生打包）            |
| 包管理     | pnpm                                 |

## 软件架构

应用为纯前端单页应用，数据流向：

```
视图（今日 / 日历 / 分组 / 设置）
        │  操作
        ▼
Pinia Store（task / group）
        │  watch 自动同步
        ▼
usePersistence（localStorage 持久化）
```

```
src/
├── views/          # 页面视图：今日待办、日历、分组管理、设置
├── components/     # 业务组件：任务卡片、任务表单、日历网格、日抽屉等
├── stores/         # Pinia：任务 store、分组 store
├── composables/    # use-persistence（本地持久化）、use-sheet（弹层状态）
├── utils/          # 日期 / 周期匹配、节假日判断、CSV 解析与生成
├── data/           # 中国法定节假日与调休数据
├── types/          # 类型定义与常量
├── styles/         # SCSS 变量与 Mixin
└── router/         # 路由配置
```

## 安装教程

**环境要求**：Node.js ≥ 20.19（推荐使用 [nvm](https://github.com/nvm-sh/nvm) 管理），pnpm ≥ 9，或使用 npm（建议优先 pnpm 以匹配 `pnpm-lock.yaml`）。

```bash
# 1. 克隆仓库
git clone https://gitee.com/izunaRen/shiguang.git
cd shiguang

# 2. 安装依赖
pnpm install

# 3. 启动开发服务器（默认 http://localhost:5173）
pnpm dev

# 4. 构建生产产物
pnpm build

# 5. 本地预览构建产物
pnpm preview
```

## 使用说明

1. **新建任务**：点击右下角「＋」→ 填写任务内容，选择分组、日期、时间、提醒与周期规则后保存
2. **完成任务**：点击任务左侧勾选框即可标记完成；同一天再次点击可取消
3. **周期任务**：选择「每天 / 每周 / 每月 / 每年 / 每个工作日」时，可设置开始 / 结束日期，并按周期类型配置具体日期（如每周一三五、每月 15 号、每年 3 月 8 日）；不同日期的完成状态独立记录
4. **日历使用**：按月浏览任务分布，点击任意日期会弹出当日任务抽屉，可查看、勾选、编辑或新增该日任务
5. **分组管理**：在「设置 → 分组管理」中新建、编辑、删除分组；删除分组会一并删除分组下全部任务
6. **数据迁移**：设置页可「下载模板」按表头填写后「导入 CSV」批量导入任务；随时可「导出 CSV」备份数据，用于跨浏览器 / 跨设备迁移
7. **一键清空**：设置页可清空全部任务与分组（不可恢复，建议先导出 CSV 备份）

> **注意**：数据保存在浏览器 LocalStorage 中，清除浏览器站点数据会导致任务丢失，请定期导出 CSV 备份。

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

## 许可证

本项目基于 [GNU Affero General Public License v3.0](./LICENSE) 开源协议发布。