Admui 框架开发文档

Posted 2022-02-25 admui

基本概述

Admui 的追求的目标是做到开箱即用，无需了解框架内部机制，但是我们也深知一套框架不可能满足所有客户的所有需求，所以我们仍然为您准备了前端的开发文档，以满足部分客户的定制需求，我们会不断的完善这部分的文档，请及时关注。

依赖关系

Admui 依赖于两个主要框架(库)。源码包中已经包含这两个框架(库)，无需再手动下载：

• BootStrap 4.1.3
• jQuery 3.3.1+

包含内容

Admui 提供了自动构建和基础源码两种不同的版本。

自动构建

如果您购买源码时选择的前端源码是自动构建，下载源码解压后，大体源码结构如下：

Admui/ ├── build/ (Gulp任务流) │ ├── configuration/ │ └── tasks/ ├── public/ │ ├── data/ (模拟数据) │ ├── fonts/ (字体图标) │ ├── images/ (图片文件) │ └── vendor/ (插件) ├── src/ │ ├── assets/ (静态资源) │ │ ├── js/ │ │ └── scss/ │ ├── fonts/ (字体图标) │ ├── templates/ (页面) │ ├── themes/ (主题) │ │ ├── base/ (布局) │ │ ├── topbar/ (布局) │ │ └── global/ │ └── .csscomb.json ├── package.json ├── gulpfile.js ├── .eslintrc(eslint配置) ├── README.md ├── .gitignore └── LICENSE

对于包含自动构建部分的前端源码，可以通过命令行来开发和调试，请参考 构建工具。

基础源码

如果您购买源码时选择的前端源码是基础源码，下载源码解压后，大体源码结构如下：

Admui/ ├── html/ (页面) ├── public/ │ ├── css/ (样式文件) │ ├── data/ (模拟数据) │ ├── fonts/ (字体图标) │ ├── images/ (图片文件) │ ├── js/ (js文件) │ ├── themes/ (主题) │ │ ├── base/ (布局) │ │ ├── topbar/ (布局) │ │ └── global/ │ └── vendor/ (插件) ├── README.md └── LICENSE

运行项目

自动构建

您必须下载和安装 node.js(包含 npm)，npm 是 node 的包管理工具。您可以使用node --version和npm --version来检查是否已经安装 node 和 npm。如果您已经安装了 node.js，请忽略此步骤。

您可以从这里下载 Node.js.

# 安装依赖包: npm install # 启动项目 npm run [dev | build][:topbar] # dev: 运行开发环境，提供浏览器自动刷新、增量编译、未压缩静态文件等; # build: 部署生产环境，合并压缩、替换路径、添加版本号等; # topbar: 指定编译的主题布局，默认执行base布局编译。（例：npm run dev:topbar）

假如您只购买了 topbar 布局，您也需要使用布局参数来指定编译的主题布局。

更多 Gulp 编译命令请阅读gulpfile.js，您可以在build/configuration/config.js或build/configuration/config.json中更改配置信息，通过 gulp 构建项目到指定的目录中。

基础源码

直接打开 html 文件即可预览，某些页面中包含 ajax 内容，所以最好在服务器环境（如 localhost）下打开。

如果您希望定制主题或通过 Gulp 自动构建项目，您可以通过在线升级的方式购买自动构建部分。升级

浏览器支持

Admui 可以很好的支持最新版的 PC 浏览器和智能设备浏览器，支持的浏览器如下：

浏览器	Windows	MacOS(10.9+)	ios(7.1.2+)	android(4.1+)
IE 6-11	C	N/A	N/A	N/A
Edge	A	N/A	N/A	N/A
Chrome（谷歌）	A	A	A	A
Firefox（火狐）	A	A	N/A	-
Safari	-	A	A	N/A
360 极速浏览器	A	N/A	-	-
搜狗浏览器	A	N/A	-	-
QQ 浏览器	A	N/A	-	-
百度浏览器	A	N/A	-	-
猎豹浏览器	A	N/A	-	-
微信浏览器	N/A	N/A	A	A
钉钉浏览器	N/A	N/A	A	A

Notes：X：不支持；A：支持最好；B：支持一般；C：支持糟糕；-：未测试；N/A：不存在。

更多信息请访问 BootStrap 文档。