From 55b3f609c717a1e890ad53ad4ef147c203d1c28b Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Wed, 17 Apr 2024 22:26:13 +0200 Subject: [PATCH 1/2] disable distribution builds --- build.gradle | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/build.gradle b/build.gradle index 3629431d..f1bab75f 100644 --- a/build.gradle +++ b/build.gradle @@ -8,6 +8,11 @@ version = '0.5.0' description = "Geocoder for OSM data" +distZip.enabled = false +distTar.enabled = false +shadowDistZip.enabled = false +shadowDistTar.enabled = false + application { mainClass = 'de.komoot.photon.App'; } From 3b6ef876323fdf405b25cd7d480cd105b3c722f4 Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Wed, 17 Apr 2024 22:31:27 +0200 Subject: [PATCH 2/2] update README for new gradle build --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 90131745..904d1c54 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # photon -[![Continuous Integration](https://github.com/komoot/photon/workflows/Continuous%20Integration/badge.svg)](https://github.com/komoot/photon/actions) +[![Continuous Integration](https://github.com/komoot/photon/workflows/CI/badge.svg)](https://github.com/komoot/photon/actions) _photon_ is an open source geocoder built for [OpenStreetMap](https://openstreetmap.org) data. It is based on [elasticsearch](http://elasticsearch.org/) - an efficient, powerful and highly scalable search platform. @@ -33,7 +33,7 @@ photon software is open source and licensed under [Apache License, Version 2.0]( ### Installation -photon requires java, at least version 11. +photon requires Java, at least version 11. Download the search index (72G GB compressed, 159GB uncompressed as of 2023-10-26, worldwide coverage, languages: English, German, French and local name). The search index is updated weekly and thankfully provided by [GraphHopper](https://www.graphhopper.com/) with the support of [lonvia](https://github.com/lonvia). Now get the latest version of photon from [the releases](https://github.com/komoot/photon/releases). @@ -48,12 +48,15 @@ wget -O - https://download1.graphhopper.com/public/photon-db-latest.tar.bz2 | pb ### Building -photon uses [maven](https://maven.apache.org/) for building. To build the package from source make sure you have a JDK and maven installed. Then run: +photon uses [gradle](https://gradle.org) for building. To build the package +from source make sure you have a JDK installed. Then run: ``` -mvn package +./gradlew build ``` +This will build and test photon. The final jar cn be found in `build/libs`. + ### Usage Start photon with the following command: @@ -68,7 +71,7 @@ Check the URL `http://localhost:2322/api?q=berlin` to see if photon is running w To enable CORS (cross-site requests), use `-cors-any` to allow any origin or `-cors-origin` with a specific origin as the argument. By default, CORS support is disabled. -Discover more of photon's feature with its usage `java -jar photon-*.jar -h`. The available options are as follows: +Discover more of photon's featurse with its usage `java -jar photon-*.jar -h`. The available options are as follows: ``` -h Show help / usage