Skip to content

Latest commit

 

History

History
81 lines (64 loc) · 3.68 KB

INSTALL.md

File metadata and controls

81 lines (64 loc) · 3.68 KB
Raw

If you don't want to tinker with the code, just install JOSM and open the Settings dialog in JOSM, choose the Plugin tab, check "Mapillary" and you are ready to go.

But if you want to explore the sourcecode and maybe even improve it, first of all a 👍 for you, and here are the instructions on getting the source code and building it on your machine:

Setting up your local git-repo

git clone [email protected]:JOSM/plugin/Mapillary.git
cd Mapillary

Getting the API information

You need to supply your own API keys on build.

  • MAPILLARY_CLIENT_ID
  • MAPILLARY_CLIENT_TOKEN
  • MAPILLARY_CLIENT_SECRET

If you are building with gradle, you can either set the API keys in the environment or via properties

$ MAPILLARY_CLIENT_ID="client_id" MAPILLARY_CLIENT_TOKEN="client_token" MAPILLARY_CLIENT_SECRET="client_secret" ./gradlew build
# or
$ export MAPILLARY_CLIENT_ID="client_id"
$ export MAPILLARY_CLIENT_TOKEN="client_token"
$ export MAPILLARY_CLIENT_SECRET="client_secret"
$ ./gradlew build
# or
$ ./gradlew build -PMAPILLARY_CLIENT_ID="client_id" -PMAPILLARY_CLIENT_TOKEN="client_token" -PMAPILLARY_CLIENT_SECRET="client_secret"

If you are building with ant, you have to pass them in via the command line like so (notice -P -> -D)

$ ant -DMAPILLARY_CLIENT_ID="client_id" -DMAPILLARY_CLIENT_TOKEN="client_token" -DMAPILLARY_CLIENT_SECRET="client_secret"

Building the plugin with Gradle

This project uses the so-called Gradle wrapper. That means you have to install nothing on your machine in order to build the project. The wrapper consists of the two scripts gradlew (for UNIX-based systems like Mac and Linux) and gradlew.bat (for systems running Windows). The following examples shows the commands for Linux/Mac users, Windows users can simply replace ./gradlew with ./gradlew.bat.

If you develop using the Eclipse IDE, run the following command before opening the project in Eclipse. This will download the dependencies and tells Eclipse about where these dependencies are located on your machine:

./gradlew eclipse

As Eclipse plugins we recommend eclipse-pmd and Anyedit tools.

For just building the jar-file for the plugin, run

./gradlew jar

If you also want to run the unit tests, create a FindBugs report and a code coverage report, then the following command is for you:

./gradlew build

(look for the reports in the directory build/reports and for the packaged Mapillary.jar in the directory build/libs)

And finally, you can execute the following to build the plugin from source, and run the latest JOSM with the Mapillary plugin already loaded. This works regardless if you have JOSM installed, or which version of it. Any already present JOSM-installation stays untouched by the following command.

./gradlew runJosm

For info about other available tasks you can run

./gradlew tasks

Building the plugin with Ant

You must first get the JOSM source code Specifically, you need the option which is "recommended if you're also interested in plugins"

You will want to clone the Mapillary source code into the plugins directory. You will most likely have to specify the directory name as Mapillary will be cloned as part of checking out the JOSM repository.

For example, git clone https://github.com/JOSM/Mapillary.git Mapillary-git.

At this point, you can now run ant in the Mapillary-git directory. You will most likely want to follow Getting the API information