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.
Follow these steps to set up the project on your local machine:
-
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
- Use Git to clone the project's repository to your local machine:
-
Install Dependencies
-
Run the following command in the root of the project to install the necessary dependencies:
yarn install
yarn global add serve
-
To run the development server and view the project in your web browser:
-
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 thedemo
directory and watches for any changes.
- Use the following command to start the development server:
-
Access the Application
- After starting the server,
browser-sync
will automatically open your default web browser to the URL where the project is running (typicallyhttp://localhost:3000
). If it does not open automatically, you can manually navigate to this URL in your browser.
- After starting the server,
-
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.
- Any changes made to the files in the
- 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 theserve
script in yourpackage.json
:"serve": "browser-sync start --server 'demo' --files 'demo/*' --port 4000"