# 蓝云笔记

**Repository Path**: lanyun417/lynote

## Basic Information

- **Project Name**: 蓝云笔记
- **Description**: 基于 Vue3，Vditor 编辑器的 Markdown 笔记 Web 应用
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-03-19
- **Last Updated**: 2025-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LYNote / 蓝云笔记

LYNote / 蓝云笔记 是一个基于 Vue 3 + TypeScript + Vite 开发的现代化笔记应用，支持 Markdown 编辑、云端同步等功能。

## 功能特点

- 📝 Markdown 编辑器支持
- 🌙 深色/浅色主题切换
- 💾 本地存储
- ☁️ 云端同步
- 🔍 笔记搜索
- 📱 响应式设计
- 🎨 自定义头像
- 📤 笔记导出

## 技术栈

- Vue 3
- TypeScript
- Vite
- Pinia
- Vue Router
- UnoCSS
- Vditor (Markdown 编辑器)
- Axios
- Express (后端服务)

## 项目结构

```
LYNote/
├── client/                 # 前端项目
│   ├── src/
│   │   ├── assets/        # 静态资源
│   │   ├── components/    # 公共组件
│   │   ├── router/        # 路由配置
│   │   ├── stores/        # 状态管理
│   │   ├── types/         # 类型定义
│   │   ├── utils/         # 工具函数
│   │   └── views/         # 页面组件
│   └── package.json
└── server/                 # 后端项目
    ├── db/                 # 数据存储
    └── index.js           # 服务器入口
```

## 开发环境要求

- Node.js >= 16
- npm >= 7

阿里巴巴 npm 镜像

```bash
npm config set registry https://registry.npmmirror.com
```

## 安装和运行

1. 克隆项目

```bash
git clone https://gitee.com/lanyun417/lynote.git
cd LYNote
```

2. 安装依赖

```bash
# 安装前端依赖
cd client
npm install

# 安装后端依赖
cd ../server
npm install
```

3. 启动开发服务器

```bash
# 启动前端服务
cd client
npm run dev

# 启动后端服务
cd server
node index.js
```

## 使用说明

1. 创建笔记

   - 点击侧边栏的"+"按钮创建新笔记
   - 输入标题和内容
   - 点击保存按钮保存笔记

2. 编辑笔记

   - 点击左侧笔记列表中的笔记进行编辑
   - 修改完成后自动保存

3. 删除笔记

   - 点击笔记项右侧的删除图标
   - 确认删除操作

4. 云端同步

   - 在设置页面配置云端同步地址
   - 点击侧边栏底部的同步按钮进行同步

5. 导出笔记
   - 点击笔记项右侧的导出图标
   - 笔记将以 Markdown 格式导出

## 配置说明

### 云端同步配置

在设置页面中配置云端同步地址，格式如下：

```
http://your-server-address:port
```

在 server/safePassword.key 中输入安全密码，该密码将用于加密云端数据。

```
// server/safePassword.key

your-safe-password
```

### 主题设置

- 点击侧边栏的主题切换按钮切换深色/浅色主题
- 主题设置会自动保存

### 效果预览

`在线预览：`[https://note.lanyunblog.com](https://note.lanyunblog.com)

![alt text](./doc/1.png)

![alt text](./doc/2.png)

![alt text](./doc/3.png)

![alt text](./doc/4.png)

## 贡献指南

1. Fork 项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request

## 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情

## 联系方式

- 项目作者：LanYun
- 邮箱：168847242@qq.com
- 项目链接：[https://gitee.com/lanyun417/lynote](https://gitee.com/lanyun417/lynote)