# nimbus

**Repository Path**: newpc/nimbus

## Basic Information

- **Project Name**: nimbus
- **Description**: 基于 Python FastAPI + Vue 3 构建的全栈云盘应用，提供树形文件管理、文件夹分享、免密/密码保护分享、在线预览等功能。后端内置完整的用户管理、角色权限（RBAC）、菜单管理、数据字典、附件管理、操作审计和系统监控等基础框架能力。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-03
- **Last Updated**: 2026-07-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nimbus 云盘

基于 Python FastAPI + Vue 3 构建的全栈云盘应用，提供树形文件管理、文件夹分享、免密/密码保护分享、在线预览等功能。后端内置完整的用户管理、角色权限（RBAC）、菜单管理、数据字典、附件管理、操作审计和系统监控等基础框架能力。

## 核心功能

- 多用户网盘空间：按用户隔离文件空间，同时支持管理员跨用户查看与维护。
- 文件与文件夹管理：支持上传、分片上传、重命名、移动、复制、删除、回收站恢复。
- 分享与开放下载：支持文件/文件夹分享、免登录访问、密码校验、文件名保持一致下载。
- 目录化公开浏览：开放下载页会按共享文件夹聚合展示，并支持进入目录查看内部共享内容。
- 在线预览：支持图片、文本、PDF、视频等常见文件类型的预览。
- 平台能力复用：沿用基础框架的 RBAC、审计日志、附件管理和系统配置能力。

## 架构概览

```
Nimbus/
├── server/          # FastAPI 后端
│   ├── app/api/         # API 路由层（请求/响应/鉴权）
│   ├── app/services/    # 业务逻辑层
│   ├── app/repositories/ # 数据访问层
│   └── app/models/      # 数据库模型
├── web/             # Vue 3 + Vite + Element Plus 前端
└── doc/             # 项目文档
```

## 快速启动

### 后端

```bash
cd server
python -m venv venv
venv\Scripts\activate  # Linux: source venv/bin/activate
pip install -r requirements.txt
copy config.example.toml config.toml
python main.py
```

默认端口 `8260`，生产端口 `18650`。

### 前端

```bash
cd web
npm install
npm run dev
```

默认端口 `8261`，`/api` 请求代理到 `http://127.0.0.1:8260`。

### 默认管理员

- 开发：`admin` / `ChangeMe@12345`
- 生产：由服务器本地生产配置决定，不在仓库内提交。

## 关键目录

| 目录 | 说明 |
|------|------|
| `server/app/api/` | 12 个路由模块（auth, users, files, shares 等） |
| `server/app/services/` | 17 个 Service（含 file_service, share_service 等） |
| `server/app/repositories/` | 7 个 Repository（含 file_node_repo, share_repo 等） |
| `server/app/models/` | 7 个 Model（含 FileNode, Share, User 等） |
| `web/src/pages/index/views/` | 前端页面（drive/, system/, login 等） |

## 文档索引

| 文档 | 说明 |
|------|------|
| [AGENTS.md](AGENTS.md) | 项目协作规则 |
| [DEVELOPMENT_GUIDE.md](DEVELOPMENT_GUIDE.md) | 后端分层与开发规范 |
| [doc/MODULE_INDEX.md](doc/MODULE_INDEX.md) | 模块索引 |
| [doc/framework-capabilities.md](doc/framework-capabilities.md) | 框架内置能力 |
| [doc/security-mechanism.md](doc/security-mechanism.md) | 安全机制说明 |
| [doc/nimbus-drive-plan.md](doc/nimbus-drive-plan.md) | 网盘功能规划 |
| [server/MODULE.md](server/MODULE.md) | 后端模块文档 |
| [web/MODULE.md](web/MODULE.md) | 前端模块文档 |

## 功能截图

截图统一压缩为 `.jpg`，存放在 [`doc/images/drive/`](doc/images/drive/) 目录，方便直接提交仓库和在 README 中预览。

### 上传文件

展示网盘主页里的上传弹窗，支持拖拽与选择文件。

![上传文件](doc/images/drive/drive-upload-dialog.jpg)

### 我的分享

展示分享统计、分享列表以及打开/预览/下载/复制等操作入口。

![我的分享](doc/images/drive/drive-shares.jpg)

### 开放下载

展示开放下载首页，支持共享文件夹聚合展示、卡片化浏览和公开入口访问。

![开放下载](doc/images/drive/open-download-overview.jpg)

### 公开分享页

展示对外分享查看页，支持预览、复制分享链接和保持原文件名下载。

![公开分享页](doc/images/drive/public-share-view.jpg)