Skip to content

JackCrawfordRobertson/svg-plotter

Repository files navigation

SVG Plotter Project

This tool is designed to convert SVG files to GeoJSON, making it easier to work with SVG data in geographic applications. This README provides instructions on how to set up and run the project locally.

Installation

Follow these steps to set up the project on your local machine:

  1. Clone the Repository

    • Use Git to clone the project's repository to your local machine:
      git clone https://github.com/jackcrawfordrobertson/svg-plotter.git
      cd svg-plotter
  2. Install Dependencies

    • Run the following command in the root of the project to install the necessary dependencies:

      yarn install
      yarn global add serve

Running the Development Server

To run the development server and view the project in your web browser:

  1. Start the Server

    • Use the following command to start the development server:
      yarn serve
      yarn add serve --dev
    • This command will start a local server using browser-sync, which serves the files located in the demo directory and watches for any changes.
  2. Access the Application

    • After starting the server, browser-sync will automatically open your default web browser to the URL where the project is running (typically http://localhost:3000). If it does not open automatically, you can manually navigate to this URL in your browser.
  3. Live Reloading

    • Any changes made to the files in the demo directory will automatically trigger a reload of the web page, allowing you to see your changes in real-time.

Troubleshooting

  • Dependency Issues: If you encounter issues related to dependencies, make sure that Yarn has properly installed all packages. Try running yarn install again.
  • Port Conflicts: If browser-sync cannot start due to port conflicts, you can specify a different port in the serve script in your package.json:
    "serve": "browser-sync start --server 'demo' --files 'demo/*' --port 4000"

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published