# MyNote

**Repository Path**: xueyuTYH/my-note

## Basic Information

- **Project Name**: MyNote
- **Description**: Android开发笔记软件，是一个智能笔记应用，允许用户在本地（或云端）创建、搜索、管理笔记内容，并可以借助 AI 自动生成摘要、主题标签或推荐。
- **Primary Language**: Unknown
- **License**: LGPL-2.1
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-24
- **Last Updated**: 2025-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MyNote

MyNote 是一个使用 Kotlin 编写的 Android 笔记管理应用，支持用户注册、登录、笔记的增删改查以及搜索功能。

## 📝 项目简介

**MyNote** 是一个简单的笔记管理应用，支持以下功能：

- 用户注册与登录（密码加密存储）
- 笔记的创建、编辑、删除
- 笔记搜索功能
- 标签管理（未来可扩展）

项目使用 **Room 持久化库** 进行本地数据库管理，采用 **MVVM 架构**，并结合 **Kotlin 协程** 进行异步操作。

## 🧱 技术架构

- **数据层**：使用 Room 数据库，包含 `User`, `Note`, `Tag` 三个实体类，通过 DAO 接口进行数据库操作。
- **业务逻辑层**：通过 `Repository` 类封装数据操作逻辑。
- **视图模型层**：使用 `ViewModel` 管理 UI 相关数据，避免内存泄漏。
- **UI 层**：使用 `Activity` 和 `Binding` 实现视图交互。

## 📁 主要模块说明

### 数据库模块

- `AppDatabase.kt`：Room 数据库抽象类，定义数据库结构。
- `User.kt`、`Note.kt`、`Tag.kt`：数据库实体类。
- `UserDao.kt`、`NoteDao.kt`、`TagDao.kt`：数据库操作接口。

### 用户模块

- `UserRepository.kt`：用户数据操作封装。
- `AuthViewModel.kt`：用户登录与注册逻辑。
- `LoginActivity.kt`：登录界面。
- `SecurityUtils.kt`：密码加密工具类。

### 笔记模块

- `NoteListViewModel.kt`：管理笔记列表数据。
- `MainActivity.kt`：主界面，展示笔记列表。

## 🧪 测试模块

- `ExampleUnitTest.kt`：本地单元测试。
- `ExampleInstrumentedTest.kt`：Android 仪器测试。

## 🚀 快速开始

### 环境准备

- Android Studio (建议最新稳定版本)
- JDK 11+
- Android SDK (API 21+)

### 构建与运行

1. 克隆项目：
   ```bash
   git clone https://gitee.com/xueyuTYH/my-note.git
   ```

2. 使用 Android Studio 打开项目并同步 Gradle。
3. 连接 Android 设备或启动模拟器。
4. 点击 Run 按钮运行项目。

## 📌 使用说明

- 首次使用请注册账号。
- 登录后可查看、添加、编辑、删除笔记。
- 支持通过标题关键字搜索笔记。

## 🤝 贡献指南

欢迎提交 PR 和 Issue。请确保代码风格统一，并添加必要的注释和测试用例。

## 📄 许可证

该项目使用 MIT 许可证，请查看 [LICENSE](LICENSE) 文件了解详细信息。