# edge_note

**Repository Path**: kubim/edge_note

## Basic Information

- **Project Name**: edge_note
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-02
- **Last Updated**: 2026-08-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EdgeNote

> 个人工作台：今日、日历、计划、任务与进度管理

EdgeNote 是一款基于 Electron + React 的桌面端个人生产力工具，采用暗色系霓虹风格 UI，帮助你集中管理日常任务、项目进度和日历计划。

## ✨ 特性

- 📊 **工作台概览** — KPI 卡片、完成率环形图、7 天柱状图、30 天趋势折线图
- 📅 **日历视图** — 可视化月历，快速查看和管理每日任务
- 📝 **计划管理** — 今日计划、短期计划，勾选即完成
- 📁 **项目管理** — 多项目分类、进度追踪、颜色标记
- ⚙️ **本地优先** — SQLite 本地存储，数据始终在你手中
- 🖥️ **原生桌面体验** — 自定义无边框窗口、系统托盘、单实例运行
- 🌙 **暗色主题** — 霓虹色调、毛玻璃效果，护眼舒适

## 🛠 技术栈

| 类别 | 技术 |
|------|------|
| 桌面框架 | Electron 43 |
| 前端框架 | React 19 |
| 构建工具 | Vite 7 |
| 样式方案 | Tailwind CSS 4 |
| 数据库 | better-sqlite3 |
| 图标 | Lucide React |

## 📁 项目结构

```
edge_note/
├── electron/              # Electron 主进程
│   ├── main.js            # 入口：窗口创建、IPC 注册
│   ├── preload.js         # 预加载脚本
│   ├── db.js              # SQLite 数据库封装
│   ├── ipc.js             # IPC 通信处理
│   ├── scheduler.js       # 定时任务调度
│   └── http-server.js     # 内置 HTTP 服务
├── src/                   # 渲染进程（React）
│   ├── components/        # UI 组件
│   │   ├── TodayView.jsx
│   │   ├── CalendarView.jsx
│   │   ├── PlansView.jsx
│   │   ├── ProjectsView.jsx
│   │   ├── SettingsView.jsx
│   │   └── Charts.jsx
│   ├── utils/             # 工具函数
│   ├── App.jsx            # 根组件
│   ├── api.js             # 渲染进程 API 层
│   ├── main.jsx            # React 入口
│   └── styles.css         # 全局样式
├── index.html
├── package.json
├── vite.config.js
└── postcss.config.mjs
```

## 🚀 快速开始

### 环境要求

- Node.js >= 18
- npm >= 9

### 安装依赖

```bash
npm install
```

### 开发模式

```bash
npm run dev
```

该命令会同时启动：
- Vite 开发服务器（http://127.0.0.1:5173）
- Electron 窗口（加载开发服务器地址）

### 构建生产版本

```bash
npm run build
```

产物输出到 `dist/` 目录。

### 打包桌面应用

```bash
npm run dist
```

自动执行构建并用 electron-builder 打包为 Windows 便携版（`.exe`）。

## ⌨️ 脚本说明

| 命令 | 说明 |
|------|------|
| `npm run dev` | 启动开发环境（Vite + Electron） |
| `npm run build` | 构建前端产物 |
| `npm run start` | 直接启动 Electron（需先 build） |
| `npm run dist` | 构建并打包为桌面应用 |

## 📦 打包配置

当前配置生成 **Windows 便携版**（portable）：

- 输出目录：`release-v5/`
- 产物名称：`EdgeNote.exe`
- 应用 ID：`com.edgenote.desktop`
- 窗口尺寸：1280 × 820（最小 960 × 640）

## 🗃️ 数据存储

应用数据存储在系统用户目录下：

```
%APPDATA%/EdgeNote/
├── edge-note.db           # SQLite 数据库
└── app-config.json        # 应用配置
```

可通过环境变量 `EDGE_NOTE_USER_DATA` 自定义数据路径。

## 🔧 环境变量

| 变量 | 说明 |
|------|------|
| `ELECTRON_RENDERER_URL` | 开发模式下的渲染进程地址 |
| `EDGE_NOTE_USER_DATA` | 自定义用户数据目录 |
| `EDGE_NOTE_SMOKE` | 设为 `1` 时启动后自动退出（冒烟测试） |

## 📄 License

MIT