# DataBrain

**Repository Path**: guocc1982/data-brain

## Basic Information

- **Project Name**: DataBrain
- **Description**: DataBrain
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-06
- **Last Updated**: 2026-08-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DataBrain 智数平台

> 智慧数据，驱动未来

DataBrain 是一个企业级的智能数据平台，提供数据治理、元数据管理、数据质量监控和AI辅助数据分析等功能。

## 技术栈

### 后端
- **语言**: Python 3.12
- **框架**: FastAPI 0.115+
- **ORM**: SQLAlchemy 2.0+
- **数据库**: PostgreSQL 16.x
- **缓存**: Redis 7.2+
- **身份认证**: JWT (python-jose)
- **迁移工具**: Alembic

### 前端
- **框架**: Vue 3.4 + TypeScript
- **构建工具**: Vite 6.5+
- **UI组件**: Element Plus 2.8+
- **状态管理**: Pinia 2.1+
- **路由**: Vue Router 4.3+
- **HTTP客户端**: Axios 1.7+
- **样式**: Tailwind CSS 3.4+

## 项目结构

```
data-brain/
├── backend/                    # 后端服务
│   ├── app/                    # 应用主目录
│   │   ├── api/                # API路由
│   │   │   └── v1/             # API版本1
│   │   ├── core/               # 核心配置
│   │   ├── models/             # 数据库模型
│   │   ├── schemas/            # Pydantic模式
│   │   ├── services/           # 业务服务
│   │   ├── utils/              # 工具函数
│   │   ├── __init__.py
│   │   └── main.py             # FastAPI入口
│   ├── migrations/             # 数据库迁移
│   ├── .env                    # 环境变量
│   ├── alembic.ini             # Alembic配置
│   └── requirements.txt        # Python依赖
├── frontend/                   # 前端应用
│   ├── src/
│   │   ├── components/         # Vue组件
│   │   ├── views/              # 页面视图
│   │   ├── stores/             # Pinia状态管理
│   │   ├── services/           # API服务
│   │   ├── router/             # 路由配置
│   │   ├── types/              # TypeScript类型
│   │   ├── utils/              # 工具函数
│   │   ├── App.vue             # 根组件
│   │   ├── main.ts             # 入口文件
│   │   └── style.css           # 全局样式
│   ├── index.html
│   ├── package.json
│   ├── vite.config.ts
│   └── tsconfig.json
├── docs/                       # 项目文档
├── .trae/                      # TRAE配置
└── README.md                   # 项目说明
```

## 快速开始

### 环境要求

- Python 3.12+
- Node.js 18+
- PostgreSQL 16+
- Redis 7.2+

### 后端启动

1. 进入后端目录
```bash
cd backend
```

2. 安装依赖
```bash
pip install -r requirements.txt
```

3. 配置环境变量
```bash
cp .env.example .env
# 编辑 .env 文件，配置数据库连接等
```

4. 运行数据库迁移
```bash
alembic upgrade head
```

5. 启动开发服务器
```bash
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
```

### 前端启动

1. 进入前端目录
```bash
cd frontend
```

2. 安装依赖
```bash
npm install
```

3. 启动开发服务器
```bash
npm run dev
```

## API文档

启动后端服务后，可访问以下地址查看API文档：

- Swagger UI: http://localhost:8000/api/docs
- ReDoc: http://localhost:8000/api/redoc

## 功能模块

### 已实现

- ✅ **租户管理**: 多租户支持，租户创建、编辑、删除
- ✅ **用户管理**: 用户CRUD、密码重置、角色分配
- ✅ **角色管理**: 角色CRUD、权限配置、系统角色
- ✅ **身份认证**: JWT登录、登出、密码修改

### 待实现

- ⬜ **元数据管理**: 数据表、字段、索引等元数据
- ⬜ **数据目录**: 数据资产浏览、搜索、标签管理
- ⬜ **数据质量**: 质量规则定义、监控、告警
- ⬜ **SQL查询**: SQL编辑器、查询执行、结果展示
- ⬜ **AI智能体**: 自然语言查询、数据洞察

## 开发规范

- 后端规范: `.trae/rules/backend.md`
- 前端规范: `.trae/rules/frontend.md`
- 全局规范: `Agent.md`

## 许可证

MIT License