# TauriNote

**Repository Path**: SunShineGo/TauriNote

## Basic Information

- **Project Name**: TauriNote
- **Description**: Tauri Note 是一款基于 Tauri、React 和 Rust 开发的开源 Markdown 笔记软件，旨在提供类似于 Typora 的优雅写作体验，同时支持本地化存储，确保用户数据的安全与隐私。它结合了现代前端技术与 Rust 的高性能后端，为用户提供了一个轻量级、跨平台的笔记工具
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2025-03-14
- **Last Updated**: 2025-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# **Tauri Note：开源 Markdown 笔记软件**

## **软件简介**

Tauri Note 是一款基于 Tauri、React 和 Rust 开发的开源 Markdown 笔记软件，旨在提供类似于 Typora 的优雅写作体验，同时支持本地化存储，确保用户数据的安全与隐私。它结合了现代前端技术与 Rust 的高性能后端，为用户提供了一个轻量级、跨平台的笔记工具。

## 页面
![这是图片](./doc/xuanxuan_2025-3-1.png)

![这是图片](./doc/2025-03-01-165540.png)
+ 点击顶部可以展开收起文件夹目录。鼠标移动到文件夹然后 **鼠标右键** 可以创建或者删除笔记。

![屏幕截图](./doc/2025-03-01.png)

+ 编辑器使用 “/”唤起菜单
+ 基于tiptap 仿notion 块级编辑器。可自定义功能

### **功能特点**

1. **Markdown 支持**

   - 支持实时预览、语法高亮、代码块渲染以及数学公式支持。
   - 类似于 Typora 的编辑体验，所见即所得。
2. **本地化存储**

   - 数据存储在本地，支持 Markdown 文件格式，方便备份和迁移。
   - 通过 Rust 后端实现数据加密，确保隐私。
3. **开源与扩展性**

   - 完全开源，代码托管于 GitHub，用户可自由定制和扩展。
   - 支持插件系统，用户可根据需求开发或安装插件。
4. **跨平台支持**

   - 支持 Windows、macOS 和 Linux 等主流操作系统。

## **开发者指南：运行与打包**

### **环境准备**

1. **Node.js**：建议版本 14.x 或更高。
2. **Rust**：建议版本 1.50 或更高。
3. **Tauri CLI**：通过以下命令安装：
   ```bash
   cargo install tauri-cli
   ```
4. **其他依赖**：确保安装了 Microsoft C++ 构建工具和 WebView2。

### **项目启动**

1. **克隆项目**
   ```bash
   git clone https://github.com/your-project-repo.git
   cd your-project-repo
   ```
2. **安装依赖**
   ```bash
   npm install
   ```
3. **启动开发服务器**
   ```bash
   npm run tauri dev
   ```

   此命令将启动 Tauri 开发模式。

### **打包应用**

1. **构建应用**
   ```bash
   npm run tauri build
   ```

   此命令将生成可执行文件。
2. **配置文件**
   - 修改 `src-tauri/tauri.conf.json` 文件，调整应用程序名称、窗口大小等参数。
   - 示例配置：
     ```json
     {
       "package": {
         "productName": "Tauri Note",
         "version": "0.1.0"
       },
       "tauri": {
         "windows": [
           {
             "title": "Tauri Note",
             "width": 800,
             "height": 600
           }
         ]
       }
     }
     ```

### **前端与后端通信**

- 使用 Tauri 提供的 `invoke` 函数调用 Rust 后端功能。
- 示例：
  ```javascript
  import { invoke } from '@tauri-apps/api';
  invoke('your_rust_function', { param: 'value' });
  ```

### **Rust 后端开发**

- 在 `src-tauri/src/main.rs` 中定义 Rust 函数，并通过 `#[tauri::command]` 注解暴露给前端。
- 示例：
  ```rust
  #[tauri::command]
  fn your_rust_function(param: &str) -> String {
      format!("处理结果: {}", param)
  }
  ```

## **总结**

Tauri Note 是一个结合了 Tauri、React 和 Rust 的开源 Markdown 笔记软件，支持本地化存储和跨平台使用。开发者可以通过上述指南快速上手开发、运行和打包应用，为用户提供高效、安全的笔记工具。