# ThinkNote

**Repository Path**: wangchuyi1122/ThinkNote

## Basic Information

- **Project Name**: ThinkNote
- **Description**: 网页端和移动端的产物
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-08
- **Last Updated**: 2026-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Think

一款现代化的个人知识管理与笔记应用，支持富文本编辑、任务管理与多端适配。

## 功能特性

- **多类型文档** — 支持富文本（Text）、笔记（Note）、待办任务（Task）三种文档类型
- **富文本编辑** — 基于 WangEditor 的所见即所得编辑器，支持图片上传与裁剪
- **文件组织** — 文件夹层级管理、置顶、移动、回收站与一键恢复
- **全局搜索** — 跨文档全文搜索
- **主题切换** — 亮色 / 暗色 / 跟随系统三种模式
- **最近文档** — 快速访问最近编辑的内容
- **PWA 支持** — 可安装为桌面/移动端应用，支持离线使用
- **响应式设计** — 兼容桌面端与移动端
- **云存储** — 媒体文件通过阿里云 OSS 管理
- **用户系统** — 注册、登录、邮箱验证

## 技术栈

| 类别 | 技术 |
|------|------|
| 框架 | React 19 + TypeScript 5 |
| 路由 | React Router DOM 7 |
| 状态管理 | Zustand 5 |
| 构建工具 | Vite 7 + SWC |
| 编辑器 | WangEditor (Slate 内核) |
| HTTP 客户端 | Axios |
| 云存储 | 阿里云 OSS |
| 样式 | CSS / LESS + CSS 变量主题 |
| 虚拟列表 | @tanstack/react-virtual |
| PWA | vite-plugin-pwa |

## 快速开始

**安装依赖**

```bash
npm install
```

**启动开发服务器**

```bash
npm run dev
# 默认运行在 http://localhost:4000
```

**构建生产版本**

```bash
npm run build
```

**构建单文件版本**（所有资源内联至一个 HTML 文件）

```bash
npm run build:single
```

## 项目结构

```
src/
├── apis/           # API 请求封装（用户、笔记、通用）
├── assets/         # 字体、图标等静态资源
├── components/     # 通用 UI 组件
├── hooks/          # 自定义 React Hooks
├── router/         # 路由配置与页面过渡动画
├── store/          # Zustand 全局状态
├── styles/         # 组件样式（LESS）
├── utils/          # 工具函数（请求封装、本地存储、OSS 上传）
└── views/          # 页面级组件
    ├── Index/      # 主布局（侧边栏 + 顶栏）
    ├── Home/       # 文件浏览
    ├── Text/       # 富文本编辑
    ├── Note/       # 笔记编辑
    ├── Task/       # 任务管理
    ├── Search/     # 全局搜索
    ├── Latest/     # 最近文档
    ├── Recycle/    # 回收站
    └── Global/     # 全局设置
```

## 环境变量

在项目根目录创建对应环境文件（参考 `.env.development` / `.env.production`），配置后端接口地址及阿里云 OSS 信息。

## 部署

项目内置 SSH/SFTP 部署脚本：

```bash
node scripts/deploy.js
```

如需生成 SSL 证书：

```bash
node scripts/ssl.js
```

## License

MIT