Skip to content
captv89Public

About

Find the shortest sea route between any two positions. This is insprited by the searoute project by eurostat.

Topics

Resources

Stars

8 stars

Watchers

2 watching

Forks

Repository files navigation

Short Sea Route Finder

This web application allows users to find waypoints along a sea route between an origin and a destination. The waypoints and the route are displayed on a map together with the total distance.

Screenshot

Prerequisites

Installation

Clone the repository:

git clone https://github.com/captv89/seaRoute.git

Navigate to the project directory:

cd seaRoute

Start the server (Go downloads the dependencies on first run):

go run .

Open your browser and navigate to http://localhost:8080 to use the application.

Environment

Variable Purpose
PORT HTTP port (default 8080)
CARTO_API_KEY CARTO base maps. Without it the map uses OpenStreetMap.
OWM_API_KEY OpenWeatherMap overlay
GA_TRACKING_ID Google Analytics (optional)

CARTO keys can be restricted to a domain. Use a key allowed for the host you serve from: the production key on the production domain, a separate key allowed for localhost when running locally:

CARTO_API_KEY=<localhost key> go run .

With Docker Compose, the variables come from .env next to docker-compose.yml. Create the container with docker compose up -d so it reads that file; a container recreated from an old container's configuration keeps the old variables.

Usage

  • Enter the latitude and longitude of the origin and destination in the form.
  • Click the "Calculate" button to retrieve the waypoints and the route.
  • The waypoints, route details and the total distance will be displayed in the map on clicking the waypoint and route respectively.

References

Marnet Dataset from the searoute project by eurostat.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Find the shortest sea route between any two positions. This is insprited by the searoute project by eurostat.

Topics

Resources

Stars

8 stars

Watchers

2 watching

Forks

Used by

Contributors

Languages