qb-web 项目使用教程

qb-web 项目使用教程

qb-webA qBittorrent Web UI, write in TypeScript+Vue.项目地址:https://gitcode.com/gh_mirrors/qb/qb-web

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

qb-web 项目的目录结构如下：

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

目录结构介绍

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

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts，其主要功能是初始化 Vue 应用并挂载到 DOM 中。

import { createApp } from 'vue';
import App from './App.vue';
import router from './router';
import store from './store';

createApp(App)
  .use(router)
  .use(store)
  .mount('#app');

启动文件介绍

• createApp(App): 创建 Vue 应用实例。
• .use(router): 使用 Vue 路由。
• .use(store): 使用 Vuex 状态管理。
• .mount('#app'): 将应用挂载到 DOM 中的 #app 元素。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 vue.config.js。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "qb-web",
  "version": "1.0.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "vue": "^3.0.0",
    "vue-router": "^4.0.0",
    "vuex": "^4.0.0"
  },
  "devDependencies": {
    "@vue/cli-service": "~4.5.0",
    "typescript": "~4.1.5"
  }
}

vue.config.js

vue.config.js 文件用于配置 Vue 项目的构建选项。

module.exports = {
  publicPath: '/',
  outputDir: 'dist',
  assetsDir: 'assets',
  lintOnSave: true,
  devServer: {
    proxy: {
      '/api': {
        target: 'http://localhost:3000',
        changeOrigin: true,
        pathRewrite: { '^/api': '' }
      }
    }
  }
};

配置文件介绍

• publicPath: 部署应用时的基本 URL。
• outputDir: 构建输出目录。
• assetsDir: 静态资源目录。
• lintOnSave: 保存时是否进行代码检查。
• devServer: 开发服务器配置，包括代理设置。

以上是 qb-web 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

qb-webA qBittorrent Web UI, write in TypeScript+Vue.项目地址:https://gitcode.com/gh_mirrors/qb/qb-web