2 Star 15 Fork 1

qiusuo0226 / base_front

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

base_front

后端开发 学习前端项目提供模块化、标准化的基础纯净开发框架,方便定制化开发。

  • 为方便学习高版本依赖应用,本项目会融合vue2.X和vue3.X的多种写法
  • 所有的依赖都是基于vue的主体版本选择比较新的比较稳定的搭配方案,力求控制台不见一点红。
  • 开源组件采用 ant-design-vue , 相较于 Element-ui 虽比较复杂,但是组件多啊,方便实现 更多定制化需求。

无法持续更新,本人作为后端开发,在学到新东西就更新下,主要用于大家小项目的学习以及开发
欢迎前端大佬提供学习优化建议!!!

提供:

  • 模块化国际化配置
  • 模块化路由配置
  • 模块化VueX配置
  • 模块化Api配置
  • 便捷开发组件及使用文档(README.md)
  • 必要工具类(有新的就会加上……持续更新)
位置 说明
src/utils/security/aes.js aes加密
src/utils/security/sm2.js sm2加密
src/utils/security/sm3.js sm3加密
src/utils/security/md5.js md5加密
src/utils/security/base64.js base64加密
src/utils/date.js 日期工具类
src/utils/request.js http工具类
src/utils/browser.js 浏览器工具
src/utils/common.js 通用工具
  • 必要的全局 变量(有新的就会加上……持续更新)
调用名 说明
$axios 原生的axios
$config 全文配置

项目启动

想要开发环境启动很简单,项目拉下来,npm install完npm run serve,前置条件是有node环境(本人开发环境都是node12及以上的版本), 为确保依赖的一致性请不要随意修改 package-lock.json , 如果 npm install 依赖下载不下来,可以删除 package-lock.json 后重试

npm install  下载依赖
npm run serve  启动项目
npm run build  打包项目
npm run test
npm run lint

项目一级目录及文件说明

文件夹或文件名 说明
READEME_IMAGE READEME.md中的一些图片文件,可删除
public 不打包成模块的公共文件
src 核心代码及配置文件
.browserslistrc 浏览器适配文件
.env 项目环境变量配置文件
.eslintignore eslint代码规范校验的忽略配置文件
.eslintrc.js eslint代码规范校验的配置规则文件
.gitignore git提交忽略文件
babel.config.js Babel JS编译器的配置文件
jsconfig.json JS项目根目录的指向性文件
LICENSE 开源文件
package.json 版本依赖控制文件
package-lock.json 版本依赖锁定文件
vue.config.js 核心配置文件(打包,代理,解析器。。。)

项目的使用和配置

1、名称配置

修改 .env文件 配置文件下的 VUE_APP_TITLE 的值

VUE_APP_TITLE=项目名称

2、项目端口配置

修改 vue.config.js文件devServer.port的值,默认端口8001

  devServer: {
    port: 8001
  }

3、项目基础路径配置

修改 .env文件 配置文件下的 BASE_URL 的值,配置完后项目启动的基础路径就是 http://127.0.0.1:8001/base

BASE_URL=/base

4、Api接口代理配置

详细接口请求配置请参考:链接地址

5、模块路由配置(权限控制)

详细路由配置请参考: 链接地址
路由的标题也支持国际化配置,若要配置请详细阅读README.md文件

6、全局配置文件

修改 settings全局配置文件
全局获取 $config

7、I18n国际化配置

请参考: 链接地址

8、vuex使用与配置

请参考: 链接地址

8.1、 已配置项

配置项 说明
this.$store.state.locale 当前选择的国际化语言
this.$store.state.login.userInfo 当前登录的用户信息

9、组件使用

参考 src/components 下每个文件夹各自的 README.md 文件

组件名 说明 地址
QDistrictsCascader 行政区划级联选择器 链接地址
QDownload 下载组件 链接地址
QException 异常页面组件 链接地址
QLanguageSelect 国际化下拉选择器组件 链接地址
QLoading 加载效果组件 链接地址
QSvg svg图片渲染组件 链接地址
QTable 表格组件 链接地址

项目功能点修改

从功能页面找到对应调用方法,一层层找不容易出错。


全局默认配置文件解释

指的是 .env文件 下环境变量的配置

  • .env:全局默认配置文件,无论什么环境都会加载合并
  • .env.development :开发环境的配置文件
  • .env.production :生产环境的配置文件

vue 会根据启动命令自动加载相对应的环境配置文件,开发环境加载 .env 和 .env.development 。 生产环境加载 .env 和 .env.production 。
优先级: 环境配置文件 > 全局配置文件
当全局的配置文件和环境的配置文件有相同配置项时,环境的配置项会覆盖全局的配置项

注意:三个文件的文件名必须按上面方式命名,不能乱起名,否则读取不到文件。

配置格式

注意:属性名必须以 VUE_APP_ 开头,如:VUE_APP_XXX

已有配置说明

变量名 说明
NODE_ENV 环境
VUE_APP_VERSION 平台版本号(随意修改)
VUE_APP_TITLE 平台名称(随意修改)
BASE_URL 基础路径(常为项目名),不以 "/"结尾

已提供的根节点公共方法

export default {
  methods: {
    tos() {
      this.toIndex()
    }
  },
  inject: ['toIndex']
};

inject: ['toIndex'] 直接引入

方法名 参数 说明
reload 刷新路由
toIndex 回到首页
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

为后端开发学习前端项目提供模块化、标准化的基础纯净开发框架,方便定制化开发 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
NodeJS
1
https://gitee.com/big-suo/base_front.git
git@gitee.com:big-suo/base_front.git
big-suo
base_front
base_front
master

搜索帮助