Previm 项目启动与配置教程

1. 项目目录结构及介绍

previm 项目是一个用于预览 Markdown 文档的 Vue.js 应用程序。以下是项目的目录结构及其简要说明：

previm/
├── README.md           # 项目说明文件
├── package.json        # 项目配置文件
├── .gitignore          # git 忽略文件列表
├── public/             # 公共目录，存放静态文件
│   └── index.html       # 项目入口HTML文件
├── src/                # 源代码目录
│   ├── assets/          # 资源目录，存放静态资源
│   ├── components/      # Vue组件目录
│   ├── App.vue          # 根组件
│   ├── main.js          # Vue应用入口文件
│   └── router/          # Vue路由配置
│       └── index.js
└── vue.config.js       # Vue项目配置文件

• README.md：项目的详细介绍文件，说明了项目的功能、如何使用等信息。
• package.json：包含了项目的依赖、脚本和元数据。
• .gitignore：定义了在执行 git 操作时应当被忽略的文件和目录。
• public：包含了所有公共的静态文件，如HTML页面、CSS文件、JavaScript文件等。
• src：存放项目的源代码。
  • assets：存放静态资源，如图片、样式表等。
  • components：存放Vue组件，是构建应用的基本单元。
  • App.vue：根组件，是应用的起始点。
  • main.js：应用的入口文件，负责创建Vue实例和挂载根组件。
  • router：Vue路由配置文件夹，定义了应用的单页面路由。
• vue.config.js：Vue项目配置文件，可进行一些自定义配置。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 中的 scripts 字段定义的命令来实现的。以下是 package.json 中定义的脚本：

"scripts": {
  "serve": "vue-cli-service serve",
  "build": "vue-cli-service build",
  "test:unit": "vue-cli-service test:unit",
  "test:e2e": "vue-cli-service test:e2e"
}

启动开发服务器的命令是 npm run serve 或 yarn serve，该命令会调用 vue-cli-service serve。这个命令启动了一个本地开发服务器，并且会监视源代码的更改，在代码更新时重新编译并自动刷新浏览器。

3. 项目的配置文件介绍

previm 项目的配置主要通过 vue.config.js 文件进行。该文件是可选的，如果项目的配置比较简单，可以不使用这个文件，而是使用 package.json 中的 vue 字段。

以下是一个基本的 vue.config.js 文件示例：

module.exports = {
  // 基本路径
  publicPath: '/',
  // 构建时的输出目录
  outputDir: 'dist',
  // 放置静态资源的目录
  assetsDir: 'static',
  // html的输出路径
  indexPath: 'index.html',
  // 文件名哈希
  filenameHashing: true,
  // eslint-loader 是否在保存的时候检查
  lintOnSave: process.env.NODE_ENV !== 'production',
  // 是否使用包含运行时编译器的Vue核心的构建
  runtimeCompiler: false,
  // 默认情况下 babel-loader 忽略其中的所有文件 node_modules
  transpileDependencies: [],
  // 生产环境 sourceMap
  productionSourceMap: false,
  // 跨域设置
  devServer: {
    open: process.platform === 'darwin',
    host: '0.0.0.0',
    port: 8080,
    https: false,
    hotOnly: false,
    proxy: null // 设置代理
  }
};

这个配置文件定义了项目的公共路径、输出目录、静态资源目录等配置，还包含了一些开发服务器（devServer）的配置，如是否在开发时打开浏览器、监听的地址和端口等。通过修改这个文件，可以自定义Vue项目的构建和开发过程。