Skip to content

qanastek/DeskMap

Repository files navigation

DeskMap

Desktop version of map browser such as Google Maps

This software was developped as an assignment during the 2019/20 university year at the CERI, Avignon University (France), by the following student:

  • Yanis Labrak

It can be used to browse maps extracted from OpenStreetMap.

Preview

Organization

The source code is organized around the MVC pattern.

  • At the root of the deskmap package:
    • Models
      • Contain all the class for the objects
    • Vues
      • Contain all the FXML files which each corresponding to a "Vue"
    • Controllers
      • Contain all the methods which will handle the events for a specific view
    • Resources
      • Contain all the resources like the pictures and CSS style-sheets
    • Services
      • Contain all others classes like the one where the queries was build or another one which draw on the canvas
    • Config
      • Contain all configuration classes like the one which contain all the color variable or another one which store all the limits, the thickness of the roads, etc...
    • The main class of the project
      • Launcher.java

Installation

Here is the procedure to install this software :

  1. Download the executable in the release section
  2. Setup the build path
    1. Source > Add Folder > Choose the src folder
    2. Libraries
      • Add External Jar > Select json-simple-1.1.1.jar
      • Add Library > JavaFX SDK
      • Add Library > JRE System Library
  3. Run it

Use

  1. In order to use the software, you must have an internet connection
  2. You need to have at least the version 1.8 of JavaSE
  3. Run the software
  4. Enter the city in which you want to make the path calculation
  5. Enter the departure and the arrival of your route thanks to :
    • The two text fields or
    • The set departure/arrival option in the informations menu when you right click on the map.
  6. Press start

The project Wiki (put a hyperlink) contains detailed instructions regarding how to use the software.

Dependencies

The project relies on the following libraries:

  • Json-Simple : This library was used to parse the JSON data received from the OSM API server (available in JavaEE)

And the following services:

  • Open Street Map: This service was used for fetching the geographical data needed for this project

Development environment

References

During development, we use the following bibliographic resources: