Skip to content

README.md

Latest commit

 

History

History
242 lines (171 loc) · 5.72 KB

README.md

File metadata and controls

242 lines (171 loc) · 5.72 KB
Raw

Axure Share

基于 Flask 的 Axure 原型分享平台，支持原型文件上传、多角色账号管理、AI对话答疑等功能。

功能特性

  • 用户认证与权限管理
  • Axure 原型文件上传与管理
  • AI 智能答疑对话（内嵌向量数据库），需设置规则元件关键词（元件命名）
  • 支持多角色账号简易权限管理
  • 支持自动渲染markdown元件，需将该元件命名为MDAS
  • 原型分享，支持公开、密码保护分享、私有模式
  • 浏览器插件：支持 Edge 插件 预览 Axure 时快速上传到托管平台

示例

技术栈

  • 后端：Flask 3.1.2
  • 数据库：SQLAlchemy (SQLite)
  • 用户认证：Flask-Login
  • 表单处理：Flask-WTF
  • 数据库迁移：Flask-Migrate (Alembic)
  • AI 集成：支持OPENAI协议的多种 AI API (SiliconFlow、小米Mimo等)
  • 向量检索：BAAI/bge-m3 嵌入模型

项目结构

axure.share/
├── app/
│   ├── services/          # 业务逻辑层
│   ├── utils/             # 工具函数
│   ├── models.py          # 数据模型
│   ├── routes.py          # 路由定义
│   ├── forms.py           # 表单定义
│   ├── permissions.py     # 权限控制
│   ├── config.py          # 配置构建
│   └── app_factory.py     # 应用工厂
├── migrations/            # 数据库迁移文件
├── static/                # 静态资源
├── templates/             # Jinja2 模板
├── uploads/               # 上传文件目录
├── instance/              # 数据库实例目录
├── .env.example           # 环境变量示例
├── requirements.txt       # Python 依赖
└── app.py                 # 应用入口

快速开始

1. 克隆项目

git clone <repository-url>
cd axure.share

2. 创建虚拟环境

python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows

3. 安装依赖

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

4. 配置环境变量

复制 .env.example 为 .env 并配置相关参数：

cp .env.example .env

主要配置项说明：

配置项 说明
SECRET_KEY Flask 秘钥密钥
SQLALCHEMY_DATABASE_URI 数据库连接 URI
MAIN_AI_API_KEY 主 AI API 密钥
MAIN_AI_BASE_URL 主 AI API 地址
SILICONFLOW_API_KEY SiliconFlow API 密钥
EMBEDDING_MODEL 嵌入模型名称

5. 数据库初始化

flask db upgrade

6. 运行应用

python app.py

访问 http://localhost:7855 即可使用。

Docker 一键部署（源码挂载方式）

项目提供了 Docker 源码挂载部署方式：镜像只提供 Python 运行环境，源码目录会挂载到容器 /workspace。因此后续修改代码或拉取最新代码后，不需要重新构建镜像，只需要重启容器即可生效。

部署要求

  • 已安装 Docker
  • Linux / Debian 环境可直接执行 .sh 脚本
  • Windows 环境可直接执行 PowerShell 脚本

Linux / Debian 一键部署

chmod +x deploy-docker.sh docker/entrypoint.sh update-docker.sh
./deploy-docker.sh

Windows PowerShell 一键部署

.\deploy-docker.ps1

部署完成后访问：

http://localhost:7855

部署脚本会自动完成以下操作：

  1. 如果不存在 .env，自动从 .env.example 复制一份。
  2. 创建 instance、uploads/prototypes、uploads/source_files、uploads/attachments 目录。
  3. 构建运行环境镜像，默认镜像名为 axure-share-runtime:latest。
  4. 删除旧容器并创建新容器，默认容器名为 axure-share。
  5. 将当前源码目录挂载到容器 /workspace。
  6. 容器启动时安装 requirements.txt、执行 flask db upgrade 并运行 python app.py。

更新代码并重启容器

如果只是修改了源码，执行：

docker restart axure-share

如果当前目录是 Git 仓库，也可以使用更新脚本自动拉取代码并重启容器：

Linux / Debian：

./update-docker.sh

Windows PowerShell：

.\update-docker.ps1

使用 docker compose 启动

如果已经构建或拉取了运行环境镜像，也可以使用：

docker compose up -d

docker-compose.yml 默认使用镜像：

axure-share-runtime:latest

如需指定镜像名：

AXURE_SHARE_IMAGE=your-registry/axure-share-runtime:latest docker compose up -d

Windows PowerShell：

$env:AXURE_SHARE_IMAGE="your-registry/axure-share-runtime:latest"
docker compose up -d

Docker 部署环境变量

变量 默认值 说明
AXURE_SHARE_IMAGE axure-share-runtime:latest Docker 镜像名称
AXURE_SHARE_CONTAINER axure-share 容器名称
AXURE_SHARE_PORT 7855 宿主机访问端口
PIP_INDEX_URL https://pypi.tuna.tsinghua.edu.cn/simple 容器内安装依赖使用的 pip 源

示例：修改端口为 8080 部署。

Linux / Debian：

AXURE_SHARE_PORT=8080 ./deploy-docker.sh

Windows PowerShell：

$env:AXURE_SHARE_PORT="8080"
.\deploy-docker.ps1

管理命令

创建管理员用户

flask admin create-admin

数据库迁移

# 生成迁移脚本
flask db migrate -m "commit message"

# 执行迁移
flask db upgrade

环境要求

  • Python 3.10+
  • SQLite 3

许可证

AGPL v3 + 禁止商业化条款 - 详见 LICENSE 文件