# xn-files

**Repository Path**: sjg/xn-files

## Basic Information

- **Project Name**: xn-files
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-22
- **Last Updated**: 2025-08-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 共享文件检索工具

## 项目概述

这是一个专为解决网络共享文件夹查找困难而开发的工具。通过建立文件索引和提供强大的搜索功能，帮助用户快速定位和访问共享文件夹中的文件。

### 主要功能

- 🔍 **快速搜索**：支持文件名、路径的模糊搜索
- 🌲 **目录树展示**：直观显示完整的文件夹结构
- 📋 **文件列表**：表格形式展示文件详细信息
- ⚡ **实时索引**：支持手动和定时更新文件索引
- 📁 **快速访问**：一键打开文件所在目录
- 📋 **路径复制**：快速复制文件完整路径

### 技术架构

- **后端**：Node.js + Express
- **前端**：Vue.js 3 + Element Plus
- **数据存储**：JSON文件索引
- **部署方式**：本地服务

## 快速开始

### 环境要求

- Node.js 18.0+ (LTS版本)
- macOS系统（已挂载网络共享文件夹）
- 现代浏览器（Chrome、Firefox、Safari等）

### 安装步骤

1. **克隆项目**（如果从代码仓库获取）
   ```bash
   git clone <repository-url>
   cd 共享文件检索
   ```

2. **安装依赖**
   ```bash
   # 安装后端依赖
   npm install
   
   # 安装前端依赖
   cd frontend
   npm install
   cd ..
   ```

3. **配置路径**
   
   编辑 `server/config/config.js` 文件，修改扫描路径：
   ```javascript
   scan: {
     targetPath: '/Volumes/公司资料集/共享文件集合',  // 修改为你的共享文件夹路径
     // ... 其他配置
   }
   ```

4. **构建前端**
   ```bash
   cd frontend
   npm run build
   cd ..
   ```

5. **启动服务**
   ```bash
   npm start
   ```

6. **访问应用**
   
   打开浏览器访问：http://localhost:3000

### 开发模式

如果需要进行开发，可以分别启动前后端：

```bash
# 启动后端服务（终端1）
npm run dev

# 启动前端开发服务器（终端2）
cd frontend
npm run dev
```

然后访问：http://localhost:5173

## 使用指南

### 1. 首次使用

1. 确保网络共享文件夹已正确挂载到系统
2. 启动应用后，点击 "开始扫描" 按钮
3. 等待扫描完成（根据文件数量，可能需要几分钟）
4. 扫描完成后即可开始搜索和浏览文件

### 2. 搜索文件

- **关键词搜索**：在搜索框中输入文件名或路径关键词
- **类型筛选**：选择特定的文件类型进行筛选
- **搜索范围**：选择在文件名、路径或全部范围内搜索
- **实时搜索**：输入后自动进行搜索，无需按回车

### 3. 浏览文件

- **目录树**：左侧显示完整的文件夹结构，可展开/收起
- **文件列表**：右侧表格显示文件详细信息
- **文件操作**：
  - 点击 "打开位置" 按钮用Finder打开文件所在目录
  - 点击 "复制路径" 按钮复制完整文件路径到剪贴板

### 4. 管理索引

- **手动刷新**：点击 "刷新数据" 按钮更新索引
- **重新扫描**：点击 "开始扫描" 按钮重新扫描文件夹
- **查看状态**：通过 "更多" > "系统状态" 查看详细信息

## 配置说明

### 服务器配置

编辑 `server/config/config.js` 文件：

```javascript
module.exports = {
  server: {
    port: 3000,                    // 服务器端口
    host: 'localhost'              // 服务器主机
  },
  scan: {
    targetPath: '/path/to/shared', // 扫描目标路径
    excludePatterns: [             // 排除的文件模式
      '.DS_Store',
      'Thumbs.db',
      '*.tmp'
    ]
  }
}
```

### 支持的文件类型

工具支持以下文件类型的分类和识别：

- **文档**：.doc, .docx, .pdf, .txt, .rtf, .odt
- **表格**：.xls, .xlsx, .csv, .ods
- **演示文稿**：.ppt, .pptx, .odp
- **图片**：.jpg, .jpeg, .png, .gif, .bmp, .tiff, .svg
- **视频**：.mp4, .avi, .mov, .wmv, .flv, .mkv
- **音频**：.mp3, .wav, .flac, .aac, .ogg
- **压缩包**：.zip, .rar, .7z, .tar, .gz
- **代码**：.js, .html, .css, .py, .java, .cpp, .c

## 故障排除

### 常见问题

1. **网络共享文件夹无法访问**
   - 确保共享文件夹已正确挂载
   - 检查网络连接是否稳定
   - 验证文件夹权限设置

2. **扫描速度慢**
   - 大型文件夹扫描需要时间，请耐心等待
   - 可以通过排除不必要的文件类型来提高速度

3. **搜索结果不准确**
   - 检查搜索关键词拼写
   - 尝试使用更具体或更模糊的关键词
   - 确保索引数据是最新的

4. **无法打开文件位置**
   - 确保浏览器允许打开本地文件
   - 在某些浏览器中可能需要手动复制路径

### 日志查看

查看应用运行日志：
```bash
# 查看服务器日志
npm start

# 查看详细日志
DEBUG=* npm start
```

## 开发信息

### 项目结构

```
shared-file-search/
├── server/                    # 后端代码
│   ├── modules/              # 核心模块
│   ├── config/               # 配置文件
│   └── server.js             # 主服务器文件
├── frontend/                 # 前端代码
│   ├── src/                 # Vue源码
│   └── dist/                # 构建输出
├── data/                    # 数据文件
├── docs/                    # 文档
└── README.md               # 说明文档
```

### API接口

主要的API端点：

- `GET /api/index` - 获取文件索引
- `POST /api/scan` - 开始文件扫描
- `GET /api/search` - 搜索文件
- `GET /api/status` - 获取系统状态

### 贡献指南

1. Fork项目
2. 创建功能分支
3. 提交更改
4. 发起Pull Request

## 版本历史

### v1.0.0 (2025-01-21)
- 初始版本发布
- 基础文件扫描和搜索功能
- Vue.js前端界面
- 支持macOS网络共享文件夹

## 许可证

MIT License - 详见LICENSE文件

## 联系方式

如有问题或建议，请通过以下方式联系：
- 项目Issues：[GitHub Issues]
- 邮箱：[your-email@example.com]

---

*本工具专为提高共享文件夹使用效率而设计，希望能帮助您更好地管理和查找文件。*