# 拾忆 · Shiyi Memo
**自托管的个人笔记站**
拾起零散记录，收好重要文件
[](LICENSE)
[](https://openjdk.org/)
[](https://spring.io/projects/spring-boot)
[](https://vuejs.org/)
[](https://www.mysql.com/)
[](#贡献)
---
## 简介
拾忆是一个可以完全自托管的个人笔记站：所见即所得地写笔记、打标签，用全文搜索随时找回来；图片、音视频和各类文件当作附件一起收进来，需要时生成一条公开链接分享给任何人。
前后端打包成单个可执行 jar，配一个 MySQL 就能跑起来；后台控制台独立于用户端，方便自己或小团队做多用户管理。
## 界面预览
| 登录 | 笔记列表 |
| --- | --- |
|  |  |
| 笔记详情 | 公开分享 |
| --- | --- |
|  |  |
| 好友列表 | 好友聊天 |
| --- | --- |
|  |  |
| 个人中心 | 后台控制台 |
| --- | --- |
|  |  |
## 功能特性
**笔记**
- 所见即所得富文本编辑：标题、列表、待办、引用、代码块、表格，字号 / 颜色 / 对齐 / 缩进随手调，图片、视频和附件可直接插入
- 标签、全文搜索、置顶与自动保存
- 多设备同一篇笔记只允许一个编辑者，其他设备实时只读；版本冲突可加载最新版或另存为副本
- 单条笔记导出为 Markdown / HTML / Word / PDF / 长图
- 笔记可一键公开分享，随时开启或关闭
**文件**
- 图片、视频、音频和任意文件上传，图片自动生成缩略图
- 个人空间配额，按用户等级控制上传上限
- 附件在线预览、下载，后台可对文件做封禁处理
**社交**
- 邮箱验证码登录，首次登录自动注册，也可设置登录密码
- 好友关系与申请、站内信、基于 SSE 的实时聊天
- 聊天支持发送图片与文件：图片气泡预览，文件卡片在线预览、下载
- 聊天记录搜索、清空会话、单向删除好友
**个人中心与后台**
- 个人资料、头像、深浅主题、空间用量查看
- 个人数据一键打包备份 / 恢复（zip：笔记 + 标签 + 附件）
- 独立后台控制台：用户、笔记、文件、消息、用户等级管理
## 技术栈
| 层次 | 技术 |
| --- | --- |
| 后端 | Java 21 · Spring Boot 3.5 · MyBatis-Plus · Flyway · JJWT |
| 前端 | Vue 3 · Vite · TypeScript · Element Plus · Pinia · Vue Router |
| 数据库 | MySQL 8 |
| 桌面端 | Electron（Windows 外壳，可选） |
| 部署 | 前端产物内嵌进 jar，PM2 守护进程 |
## 项目结构
```text
shiyi-memo/
├─ src/main/java/org/shiyi/memo/ 后端源码（auth / memo / file / friend ... 分模块）
├─ src/main/resources/
│ ├─ application.yml 默认配置
│ ├─ application-local.yml.example 本地配置模板
│ ├─ db/migration/ Flyway 数据库迁移脚本
│ └─ static/ 前端构建产物（npm run build 生成）
├─ frontend/ Vue 3 前端（前台 + 后台两个入口）
├─ desktop/ Electron 桌面端（见 desktop/README.md）
├─ design-system/ 设计系统与视觉规范
├─ start/ 可执行 jar 与线上配置（构建产物）
├─ ecosystem.config.js PM2 应用配置
├─ Dockerfile / docker-compose.yml Docker 一键构建启动（.env.example 为配置模板）
├─ start-windows.ps1 / start-linux.sh 一键构建部署脚本
└─ dev.ps1 本地开发启动脚本
```
## 快速开始
### 环境要求
- JDK 21
- Maven 3.9+
- Node.js 20+
- MySQL 8
### 1. 克隆仓库
```bash
git clone https://gitee.com/lieng618/shiyi-memo.git
cd shiyi-memo
```
> 装了 Docker 的话，可以跳过下面的环境安装和建库，直接看 [Docker 部署](#docker-部署)一条命令跑起来。
### 2. 创建数据库
```sql
CREATE DATABASE shiyi_memo
DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci;
```
表结构由 Flyway 在首次启动时自动建好，无需手动执行 SQL。
### 3. 准备本地配置
复制模板并按需填写：
```bash
cp src/main/resources/application-local.yml.example src/main/resources/application-local.yml
```
至少填写数据库连接；需要邮箱验证码登录时，再补上 SMTP 账号与授权码。
### 4. 构建并启动
```bash
cd frontend && npm install && npm run build && cd ..
mvn -DskipTests package
java -jar start/shiyi-memo-1.0.0.jar
```
Windows 双击根目录的 `start-windows.bat`，或在终端执行：
```powershell
.\start-windows.ps1
```
启动后访问：
- 用户端：