Skip to content

bong-inc/bong-maps

Repository files navigation

Bong Maps logo

Bong Maps

Bong Maps is a GIS application capable of displaying data from OpenStreetMap in the formats ZIP and OSM.

This project was developed in 10 weeks during spring 2020 as a school project by a 5-person team.

Brief

In this project, you must design and implement a system for visualizing and working with map data in the OpenStreetMap .OSM format.

Requirements included: route finding, address search and a lag-free experience achieved by use of the datastructure KD-Tree.

Result

Bong Maps logo

Running the application

Download the latest release as a .jar file.

To run the application, this file should be executed by opening it directly.

A compatible Java Runtime Environment like Java 8 or Java Development Kit JDK 13 is required.

It is also possible to run it from the command line like so:

java -jar bong.jar

Running the application using the command line exposes useful logging for development purposes.

Development

This project was initialized using gradle. Common tasks can be run through this tool. The tool is provided with the source code, so no installation is required. Only a compatible JDK is required.

Dev Tools

The dev tools provide access to advanced features, not meant for the end user. Find the devtools in More > Devtools. Some of the dev tools provide useful logging, that only is exposed when the application is run from the command line or from an IDE.

Points of interest

Points of interest are saved locally, meaning that the first time you start the program, there won't be any. Also this means that if you open the program on a different computer, the points of interest won't be there. Running the tests will clear the points of interest.

Running the application directly from source files

With the source files downloaded, run the following command in the root of the project.

gradlew run

Building an executable jar from source

gradlew jar

Running the generated executable .jar

Assuming an executable .jar file is located at the default location, run the following command at the project root:

java -jar build\libs\bong.jar

Running test suite

The project includes several automated tests, that can be run by using the following command:

gradlew test

To generate a test coverage report using JaCoCo, run gradlew test and then run the following command:

gradlew jacocoTestReport

The report is viewed by opening the generated build\reports\jacoco\test\html\index.html in your favorite browser.