Installation

To run the timezone boundary builder script locally, you need to set up the development environment. This involves cloning the repository, installing Node.js dependencies, and ensuring you have the necessary command-line tools.

Prerequisites

Before you begin, ensure you have the following installed on your system:

  1. Node.js: The project requires Node.js version 12 or higher. You can check your version by running node -v.
  2. Git: To clone the repository.
  3. zip command-line tool: Used for packaging the final release files. This is typically pre-installed on Linux and macOS.
  4. ogr2ogr command-line tool: This is part of the GDAL library and is used to convert GeoJSON files to Shapefiles. You can install it via your system's package manager (e.g., apt-get install gdal-bin on Debian/Ubuntu, brew install gdal on macOS).

Setup Steps

  1. Clone the Repository

    Open your terminal and clone the repository from GitHub: 

    git clone https://github.com/evansiroky/timezone-boundary-builder.git
cd timezone-boundary-builder

  2. Install Dependencies

    The project uses npm to manage its Node.js dependencies. Install them by running: 

    npm install
    This will install all the necessary packages listed in package.json, such as jsts for geometric operations and yargs for command-line argument parsing.

Once these steps are complete, you are ready to run the build script. See the Quick Start guide for instructions on how to generate the timezone data.