# 目录结构

<!-- TOC -->

- [目录结构](#目录结构)
  - [`.vscode`](#vscode)
  - [`blueprint-templates`](#blueprint-templates)
  - [`docs`](#docs)
  - [`public`](#public)
  - [`src`](#src)
    - [`_mock`](#_mock)
    - [`common`](#common)
      - [`assets`](#assets)
      - [`components`](#components)
      - [`design`](#design)
      - [`filters`](#filters)
      - [`services`](#services)
    - [`example`](#example)
    - [`login`、`todo`](#logintodo)
      - [`index.js`](#indexjs)
  - [`src_custom`](#src_custom)
  - [`.eslintignore`、`.eslintrc.js`](#eslintignoreeslintrcjs)
  - [`.gitattributes`、`.gitignore`](#gitattributesgitignore)
  - [`.prettierignore`、`.prettierrc.js`](#prettierignoreprettierrcjs)

<!-- /TOC -->

## `.vscode`

项目所必须的 Visual Studio Code 扩展和设置项

## `blueprint-templates`

快速生成一套 Vue 组件（vue+js+scss）所用的模板

1. sd-vue-component 组件模板
1. service 服务模板

## `docs`

你正在读 :wink:

## `public`

存放静态文件，webpack 将资源打包插入后，放到`dist`目录

## `src`

属于平台的源代码

### `_mock`

模拟后台接口的数据，用于接口未就绪时提前开发界面

### `common`

各模块间公用的代码

#### `assets`

静态资源，请参考 [HTML 和静态资源](https://cli.vuejs.org/zh/guide/html-and-static-assets.html)

#### `components`

公共组件

#### `design`

主题、设计相关资源。例如：主题色、圆角值等

#### `filters`

公共 filter。例如：格式化日期、处理字节数等

#### `services`

公共服务。例如：生成二维码、调用 GPS 位置信息等

### `example`

代码样例。一些代码的典型用法可以在这里找到

### `login`、`todo`

各个功能子模块

#### `index.js`

导入子模块时自动读取此文件。保存模块内的路由等信息

## `src_custom`

项目定制的代码

## `.eslintignore`、`.eslintrc.js`

ES Lint 代码检查工具的配置文件

## `.gitattributes`、`.gitignore`

git 相关配置

## `.prettierignore`、`.prettierrc.js`

Prettier 代码格式化工具的配置文件