NFU-Guide-Map 项目使用教程

1. 项目目录结构及介绍

NFU-Guide-Map/
├── cloudfunctions/
├── example/
├── node_modules/
│   └── typescript/
├── src/
│   ├── config/
│   ├── mock/
│   └── typings/
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── LICENSE
├── README.md
├── gulpfile.js
├── package.json
├── project.config.json
└── tsconfig.json

目录结构说明

• cloudfunctions/: 云函数目录，用于存放云开发相关的函数。
• example/: 示例代码目录，可能包含一些示例代码或配置文件。
• node_modules/: 项目依赖包目录，包含所有项目所需的第三方库。
• src/: 源代码目录，包含项目的核心代码。
  • config/: 配置文件目录，包含项目的各种配置文件。
  • mock/: 模拟数据目录，用于本地开发时的数据模拟。
  • typings/: TypeScript 类型定义文件目录。
• .eslintignore: ESLint 忽略文件配置。
• .eslintrc.js: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .prettierignore: Prettier 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• gulpfile.js: Gulp 构建脚本文件。
• package.json: 项目依赖及脚本配置文件。
• project.config.json: 小程序项目配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 src/ 目录下，具体包括：

• src/config/index.ts: 项目的入口配置文件，包含了应用的基本配置信息。
• src/cloud.ts: 云开发相关配置文件，用于配置云函数和云数据库等。
• src/info.ts: 应用介绍信息文件，包含了应用的基本介绍和使用说明。
• src/markerStyle.ts: 地图标记样式配置文件，用于定义地图上标记的样式。
• src/panorama.ts: 全景地图配置文件，用于配置第三方全景地图服务。
• src/secret.ts: 敏感信息配置文件，包含了腾讯地图的 API Key 等敏感信息。

3. 项目的配置文件介绍

3.1 package.json

package.json 文件包含了项目的依赖包信息和脚本命令，是项目管理的核心文件之一。

{
  "name": "NFU-Guide-Map",
  "version": "1.0.0",
  "scripts": {
    "dev": "npm run build && gulp",
    "build": "tsc"
  },
  "dependencies": {
    "typescript": "^3.9.7",
    "vant-weapp": "^0.5.29"
  },
  "devDependencies": {
    "gulp": "^4.0.2"
  }
}

3.2 tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，用于配置 TypeScript 编译器的行为。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  }
}

3.3 project.config.json

project.config.json 文件是小程序项目的配置文件，包含了小程序的基本配置信息。

{
  "miniprogramRoot": "./src",
  "projectname": "NFU-Guide-Map",
  "description": "南苑导览小程序",
  "appid": "your-app-id",
  "setting": {
    "urlCheck": true,
    "es6": true,
    "postcss": true
  }
}

3.4 gulpfile.js

gulpfile.js 文件是 Gulp 构建脚本文件，用于自动化构建任务。

const gulp = require('gulp');
const ts = require('gulp-typescript');

const tsProject = ts.createProject('tsconfig.json');

gulp.task('scripts', () => {
  const tsResult = tsProject.src().pipe(tsProject());
  return tsResult.js.pipe(gulp.dest('dist'));
});

gulp.task('default', gulp.series('scripts'));

通过以上配置文件和启动文件的介绍，您可以更好地理解和使用 NFU-Guide-Map 项目。