开源项目 admin-vue-template 使用教程

1. 项目的目录结构及介绍

admin-vue-template/
├── public/
│   ├── index.html
│   └── favicon.ico
├── src/
│   ├── assets/
│   ├── components/
│   ├── router/
│   ├── store/
│   ├── views/
│   ├── App.vue
│   └── main.js
├── .gitignore
├── babel.config.js
├── package.json
├── README.md
└── vue.config.js

目录结构介绍

• public/: 存放静态资源，如 index.html 和 favicon.ico。
• src/: 项目的主要源代码目录。
  • assets/: 存放静态资源，如图片、字体等。
  • components/: 存放可复用的 Vue 组件。
  • router/: 存放 Vue Router 相关配置。
  • store/: 存放 Vuex 状态管理相关配置。
  • views/: 存放页面级组件。
  • App.vue: 项目的根组件。
  • main.js: 项目的入口文件。
• .gitignore: Git 忽略文件配置。
• babel.config.js: Babel 配置文件。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• vue.config.js: Vue CLI 配置文件。

2. 项目的启动文件介绍

main.js

main.js 是项目的入口文件，负责初始化 Vue 实例并挂载到 DOM 中。以下是 main.js 的基本结构：

import Vue from 'vue'
import App from './App.vue'
import router from './router'
import store from './store'

Vue.config.productionTip = false

new Vue({
  router,
  store,
  render: h => h(App)
}).$mount('#app')

文件功能介绍

• 导入 Vue 和相关模块: 导入 Vue 库、App.vue 根组件、router 路由配置和 store 状态管理配置。
• 配置 Vue: 设置 Vue.config.productionTip 为 false，以关闭生产环境提示。
• 创建 Vue 实例: 创建一个新的 Vue 实例，并使用 router 和 store 配置，通过 render 函数渲染 App.vue 组件。
• 挂载到 DOM: 将 Vue 实例挂载到 ID 为 app 的 DOM 元素上。

3. 项目的配置文件介绍

vue.config.js

vue.config.js 是 Vue CLI 的配置文件，用于自定义构建配置。以下是一个基本的 vue.config.js 示例：

module.exports = {
  publicPath: '/',
  outputDir: 'dist',
  assetsDir: 'assets',
  lintOnSave: process.env.NODE_ENV !== 'production',
  devServer: {
    port: 8080,
    open: true
  }
}

配置项介绍

• publicPath: 部署应用时的基本 URL。
• outputDir: 构建文件的输出目录。
• assetsDir: 静态资源目录。
• lintOnSave: 是否在保存时进行代码检查。
• devServer: 开发服务器配置，如端口和是否自动打开浏览器。

package.json

package.json 文件包含了项目的依赖和脚本配置。以下是一些关键部分：

{
  "name": "admin-vue-template",
  "version": "1.0.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "vue": "^2.6.11",
    "vue-router": "^3.2.0",
    "vuex": "^3.4.0"
  },
  "devDependencies": {
    "@vue/cli