开源项目 `Administrative-divisions-of-China` 使用教程

开源项目 Administrative-divisions-of-China 使用教程

Administrative-divisions-of-China中华人民共和国行政区划：省级（省份）、 地级（城市）、 县级（区县）、 乡级（乡镇街道）、 村级（村委会居委会） ，中国省市区镇村二级三级四级五级联动地址数据。项目地址:https://gitcode.com/gh_mirrors/ad/Administrative-divisions-of-China

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

Administrative-divisions-of-China/
├── README.md
├── data/
│   ├── code.txt
│   ├── json/
│   │   ├── province.json
│   │   ├── city.json
│   │   ├── area.json
│   │   └── street.json
│   └── sql/
│       ├── province.sql
│       ├── city.sql
│       ├── area.sql
│       └── street.sql
├── generate.js
├── package.json
└── src/
    ├── index.js
    └── utils/
        └── data.js

• README.md: 项目说明文档。
• data/: 包含项目所需的数据文件，分为 JSON 和 SQL 格式。
  • code.txt: 行政区划代码文件。
  • json/: 包含省、市、区、街道的 JSON 数据文件。
  • sql/: 包含省、市、区、街道的 SQL 数据文件。
• generate.js: 用于生成数据文件的脚本。
• package.json: 项目的依赖管理文件。
• src/: 项目的源代码目录。
  • index.js: 项目的入口文件。
  • utils/: 包含一些工具函数。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件主要负责初始化项目并加载必要的数据。以下是 index.js 的简要介绍：

const fs = require('fs');
const path = require('path');
const { generateData } = require('./utils/data');

// 生成数据文件
generateData();

// 加载数据
const provinces = require('../data/json/province.json');
const cities = require('../data/json/city.json');
const areas = require('../data/json/area.json');
const streets = require('../data/json/street.json');

// 打印数据
console.log('Provinces:', provinces);
console.log('Cities:', cities);
console.log('Areas:', areas);
console.log('Streets:', streets);

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的依赖、脚本和其他元数据。以下是 package.json 的简要介绍：

{
  "name": "administrative-divisions-of-china",
  "version": "1.0.0",
  "description": "中华人民共和国行政区划数据",
  "main": "src/index.js",
  "scripts": {
    "start": "node src/index.js",
    "generate": "node generate.js"
  },
  "dependencies": {
    "fs": "0.0.1-security",
    "path": "^0.12.7"
  },
  "author": "modood",
  "license": "MIT"
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的入口文件。
• scripts: 包含项目的脚本命令，如 start 和 generate。
• dependencies: 项目的依赖包。
• author: 项目作者。
• license: 项目许可证。

Administrative-divisions-of-China中华人民共和国行政区划：省级（省份）、 地级（城市）、 县级（区县）、 乡级（乡镇街道）、 村级（村委会居委会） ，中国省市区镇村二级三级四级五级联动地址数据。项目地址:https://gitcode.com/gh_mirrors/ad/Administrative-divisions-of-China