# SaaS-Framework

**Repository Path**: easonsunfz/saa-s-framework

## Basic Information

- **Project Name**: SaaS-Framework
- **Description**: 一个SaaS多租户框架的项目基础框架
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-12-13
- **Last Updated**: 2025-12-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Fine Insights

一款基于 AI 的智能数据分析平台，采用前后端分离架构，支持多租户、团队协作等企业级功能。

---

## 技术栈

### 前端技术

| 技术 | 版本 | 说明 |
|------|------|------|
| Vue | 3.5 | 渐进式 JavaScript 框架 |
| Vite | 7.x | 下一代前端构建工具 |
| TypeScript | 5.9 | JavaScript 类型超集 |
| Vue Router | 4.x | 官方路由管理器 |
| Pinia | 3.x | Vue 状态管理库 |
| Axios | 1.x | HTTP 请求库 |
| Sass | 1.x | CSS 预处理器 |
| TipTap | 3.x | 富文本编辑器 |

### 后端技术

| 技术 | 版本 | 说明 |
|------|------|------|
| FastAPI | 0.109 | 现代高性能 Python Web 框架 |
| SQLAlchemy | 2.0 | Python ORM 框架 |
| Uvicorn | 0.27 | ASGI 高性能服务器 |
| Pydantic | 2.x | 数据验证库 |
| Python-Jose | 3.3 | JWT 认证实现 |
| Passlib | 1.7 | 密码加密库 |

### 数据库

| 技术 | 说明 |
|------|------|
| SQLite | 轻量级关系型数据库（开发环境） |

---

## 系统架构

项目采用 **模块化 + 分层架构** 设计：

- **前端**：按业务域划分为三大模块（官网、产品、管理后台）
- **后端**：采用经典分层架构（路由层、服务层、数据层）
- **通信**：RESTful API + JWT 认证

---

## 前端目录结构

```
frontend/src/
├── api/                        # API 接口封装
│   ├── admin.ts               # 管理后台接口
│   ├── auth.ts                # 认证相关接口
│   ├── docs.ts                # 文档相关接口
│   └── teams.ts               # 团队相关接口
│
├── components/                 # 公共组件
│   ├── RichTextEditor.vue     # 富文本编辑器
│   └── Toast.vue              # 消息提示组件
│
├── modules/                    # 功能模块（核心）
│   │
│   ├── website/               # 📌 官网模块
│   │   ├── components/layout/ # 官网布局组件
│   │   └── views/
│   │       ├── home/          # 首页
│   │       ├── pricing/       # 定价页
│   │       ├── docs/          # 帮助文档
│   │       └── auth/          # 认证页面（登录、注册、找回密码等）
│   │
│   ├── product/               # 📌 产品模块（核心功能）
│   │   ├── components/layout/ # 产品布局组件
│   │   └── views/
│   │       ├── workspace/     # 工作区
│   │       ├── agent/         # AI 智能体
│   │       ├── knowledge/     # 知识库
│   │       ├── datasource/    # 数据源
│   │       ├── workflow/      # 工作流
│   │       └── settings/      # 设置（账户、团队）
│   │
│   └── admin/                 # 📌 管理后台模块
│       ├── components/layout/ # 后台布局组件
│       └── views/
│           ├── auth/          # 管理员登录
│           ├── users/         # 用户管理
│           ├── tenants/       # 租户管理
│           ├── admins/        # 管理员管理
│           ├── orders/        # 订单管理
│           ├── versions/      # 版本管理
│           └── logs/          # 日志管理
│
├── router/                     # 路由配置
│   ├── index.ts               # 路由主入口
│   ├── guards.ts              # 路由守卫
│   ├── website.ts             # 官网路由
│   ├── product.ts             # 产品路由
│   └── admin.ts               # 管理后台路由
│
├── stores/                     # Pinia 状态管理
│   ├── index.ts               # Store 入口
│   ├── user.ts                # 用户状态
│   └── adminAuth.ts           # 管理员认证状态
│
├── utils/                      # 工具函数
│   └── request.ts             # Axios 请求封装
│
├── views/                      # 公共视图
│   └── NotFound.vue           # 404 页面
│
├── App.vue                     # 根组件
├── main.ts                     # 应用入口
└── style.css                   # 全局样式
```

---

## 后端目录结构

```
backend/app/
├── api/                        # API 路由层
│   ├── auth.py                # 用户认证（登录、注册、令牌刷新）
│   ├── teams.py               # 团队管理
│   ├── invitations.py         # 团队邀请
│   ├── admin_auth.py          # 管理员认证
│   ├── admin_users.py         # 用户管理（管理后台）
│   ├── admin_tenants.py       # 租户管理（管理后台）
│   ├── admin_docs.py          # 文档管理（管理后台）
│   └── example.py             # 示例接口
│
├── core/                       # 核心配置
│   ├── config.py              # 应用配置（环境变量）
│   ├── database.py            # 数据库连接配置
│   ├── security.py            # 安全相关（JWT、密码加密）
│   └── email.py               # 邮件服务
│
├── models/                     # 数据库模型（SQLAlchemy ORM）
│   ├── user.py                # 用户模型
│   ├── team.py                # 团队模型
│   ├── team_member.py         # 团队成员模型
│   ├── team_invitation.py     # 团队邀请模型
│   ├── team_slug_redirect.py  # 团队标识重定向
│   ├── superadmin.py          # 超级管理员模型
│   ├── help_document.py       # 帮助文档模型
│   └── password_reset.py      # 密码重置模型
│
├── schemas/                    # Pydantic 数据模式
│   ├── user.py                # 用户相关 Schema
│   └── team.py                # 团队相关 Schema
│
└── main.py                     # 应用入口
```

---

## 核心功能模块

### 用户系统
- 用户注册 / 登录 / 登出
- JWT Token 认证
- 密码找回
- 个人资料管理
- 头像上传

### 团队协作
- 多团队支持
- 团队创建与管理
- 成员邀请机制
- 角色权限控制（拥有者、管理员、成员）
- 团队切换

### 管理后台
- 管理员独立认证体系
- 用户管理
- 租户管理
- 订单管理
- 系统监控

### 产品功能（规划中）
- 工作区管理
- AI 智能体
- 知识库
- 数据源连接
- 工作流编排

---

## 环境要求

| 环境 | 版本要求 |
|------|----------|
| Node.js | >= 18.0.0 |
| Python | >= 3.10 |
| npm / pnpm | 最新稳定版 |

---

## 快速启动

### 一键启动（推荐）

双击运行项目根目录下的 `启动开发环境.bat` 脚本，自动完成：
- 检测并配置局域网访问
- 安装前后端依赖
- 同时启动前后端服务

### 访问地址

| 服务 | 地址 |
|------|------|
| 前端页面 | http://localhost:5173 |
| 后端 API 文档 | http://localhost:8000/docs |
| ReDoc 文档 | http://localhost:8000/redoc |

---

## 项目特性

- ✅ 前后端完全分离
- ✅ 模块化架构设计
- ✅ 多租户支持
- ✅ 团队协作机制
- ✅ JWT 安全认证
- ✅ 管理后台独立部署
- ✅ TypeScript 全面类型支持
- ✅ 自动生成 API 文档
- ✅ 热重载开发环境
- ✅ 局域网访问支持

---

## 许可证

MIT