# 局域网便签

**Repository Path**: T_Salt/lan-notes

## Basic Information

- **Project Name**: 局域网便签
- **Description**: 局域网便签：一个简单易用的局域网内共享便签工具，支持多人协作，适用于团队会议、项目管理等场景，提升团队沟通效率。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-27
- **Last Updated**: 2026-04-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 牛马便签

一个基于 `Electron + Vue 3 + PrimeVue + TypeScript` 实现的桌面便签应用。

适合用来记录待办、灵感、会议纪要和临时备忘，数据默认保存在本地，支持桌面提醒、历史记录分组、置顶、收藏、已完成等常用能力。

## 功能特性

- 新建、编辑、删除便签
- 自动保存到本地 JSON 文件
- 便签按天分组展示历史记录
- 左侧历史记录支持折叠面板效果
- 支持便签置顶
- 支持便签收藏
- 支持标记已完成
- 支持分享当前便签内容到剪贴板
- 支持提醒时间，到点触发系统通知
- 支持搜索标题和正文内容

## 技术栈

- `Electron`
- `Vue 3`
- `TypeScript`
- `Vite`
- `PrimeVue`
- `PrimeIcons`

## 开发环境

建议环境：

- `Node.js 18+`
- `npm 9+`
- Windows

## 安装依赖

```bash
npm install
```

## 运行项目

开发模式：

```bash
npm run dev
```

说明：

- 会同时启动 `Vite` 前端开发服务和 `Electron` 桌面应用
- 当前开发模式下会自动打开 Electron 开发者工具

仅启动前端预览：

```bash
npm run preview
```

## 构建项目

```bash
npm run build
```

构建完成后，前端资源会输出到 `dist` 目录。

## 启动生产模式

```bash
npm run start
```

该命令会先执行构建，再使用 Electron 加载 `dist/index.html`。

## 目录结构

```text
lan-notes/
├─ electron/
│  ├─ main.js          # Electron 主进程，负责窗口、数据存储、提醒轮询
│  └─ preload.js       # 预加载脚本，向渲染进程暴露安全 API
├─ src/
│  ├─ App.vue          # 主界面与交互逻辑
│  ├─ main.ts          # Vue 与 PrimeVue 入口
│  ├─ style.css        # 全局样式
│  └─ env.d.ts         # 全局类型声明
├─ dist/               # 构建输出目录
├─ package.json
└─ README.md
```

## 数据存储

便签数据默认存储在 Electron 用户目录下的 `notes.json` 中。

主进程中实际使用的是：

```js
app.getPath('userData')
```

因此不同机器上的真实路径可能不同。

如果只在浏览器模式下运行前端页面，则会退回使用 `localStorage` 暂存数据。

## 提醒机制

提醒采用主进程轮询的方式实现：

- 主进程定时检查所有便签的提醒时间
- 到达提醒时间后触发系统通知
- 提醒触发后写回状态，避免重复提醒

当前规则：

- 提醒时间不能早于当前时间
- 应用运行期间会持续检查提醒
- 如果提醒已到期但尚未标记，重新打开应用后也会继续检查并提醒

## 当前界面说明

左侧区域：

- 搜索框
- 按天分组的历史记录
- 折叠面板式便签列表

右侧区域：

- 便签标题
- 最近更新时间
- 操作按钮：`置顶`、`收藏`、`分享`、`删除`、`已完成`
- 正文编辑区

## 常用脚本

- `npm run dev`：开发模式启动 Vite 和 Electron
- `npm run dev:renderer`：仅启动 Vite
- `npm run dev:electron`：仅启动 Electron 开发进程
- `npm run build`：执行类型检查并构建前端
- `npm run preview`：本地预览构建结果
- `npm run start`：构建后启动 Electron
- `npm run electron`：直接运行 Electron 主进程

## 后续可扩展方向

- 托盘驻留
- 便签分类和标签
- 导出导入
- 自定义主题
- 快捷键支持
- 打包发布安装程序

## 备注

这是一个本地桌面应用，默认不依赖远程服务。