Planetary.js 项目教程

目录结构及介绍

Planetary.js 项目的目录结构如下：

planetary.js/
├── dist/
│   ├── planetaryjs.min.js
│   └── ...
├── src/
│   ├── core/
│   │   ├── d3.v3.min.js
│   │   ├── topojson.v1.min.js
│   │   └── planetaryjs.min.js
│   ├── plugins/
│   │   └── ...
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── bower.json
├── gulpfile.js
├── package-lock.json
├── package.json
└── screenshot.png

目录介绍

• dist/: 包含编译后的 JavaScript 文件，如 planetaryjs.min.js。
• src/: 包含项目的源代码，包括核心 JavaScript 文件和插件。
  • core/: 包含项目依赖的核心库，如 d3.v3.min.js 和 topojson.v1.min.js。
  • plugins/: 包含可扩展的插件。
• .gitignore: Git 忽略文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• bower.json: Bower 包管理文件。
• gulpfile.js: Gulp 构建脚本。
• package-lock.json: npm 锁定文件。
• package.json: npm 包管理文件。
• screenshot.png: 项目截图。

项目的启动文件介绍

Planetary.js 的启动文件主要是 dist/planetaryjs.min.js。这个文件是编译后的 JavaScript 文件，包含了项目的主要功能和插件。

启动文件介绍

• dist/planetaryjs.min.js: 这是项目的核心文件，包含了所有必要的功能和插件，可以直接在 HTML 页面中引用。

项目的配置文件介绍

Planetary.js 的配置文件主要是 package.json 和 bower.json。

配置文件介绍

• package.json: 包含了项目的元数据和依赖项，可以通过 npm 安装和管理依赖。
• bower.json: 包含了项目的元数据和 Bower 依赖项，可以通过 bower 安装和管理依赖。

示例配置

{
  "name": "planetary.js",
  "version": "1.0.0",
  "description": "Awesome interactive globes for the web",
  "main": "dist/planetaryjs.min.js",
  "scripts": {
    "build": "gulp build"
  },
  "dependencies": {
    "d3": "^3.5.17",
    "topojson": "^1.6.27"
  },
  "devDependencies": {
    "gulp": "^4.0.2",
    "gulp-uglify": "^3.0.2"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/BinaryMuse/planetary.js.git"
  },
  "keywords": [
    "globe",
    "interactive",
    "visualization"
  ],
  "author": "Michelle Tilley <[e-mail]>",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/BinaryMuse/planetary.js/issues"
  },
  "homepage": "https://github.com/BinaryMuse/planetary.js"
}

通过这些配置文件，可以方便地管理项目的依赖和构建过程。