{"id":23547229,"url":"https://github.com/kpanic/exalice","last_synced_at":"2025-04-24T06:10:52.901Z","repository":{"id":57498590,"uuid":"48256336","full_name":"kpanic/exalice","owner":"kpanic","description":"ExAlice, a geocoder with swappable storage","archived":false,"fork":false,"pushed_at":"2018-09-16T17:08:26.000Z","size":363,"stargazers_count":16,"open_issues_count":4,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-18T03:04:33.017Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kpanic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-18T21:02:38.000Z","updated_at":"2022-12-07T21:32:06.000Z","dependencies_parsed_at":"2022-09-06T17:10:58.984Z","dependency_job_id":null,"html_url":"https://github.com/kpanic/exalice","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpanic%2Fexalice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpanic%2Fexalice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpanic%2Fexalice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kpanic%2Fexalice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kpanic","download_url":"https://codeload.github.com/kpanic/exalice/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250573351,"owners_count":21452352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-26T09:14:59.461Z","updated_at":"2025-04-24T06:10:52.887Z","avatar_url":"https://github.com/kpanic.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ExAlice\n\n[![Build Status](https://travis-ci.org/kpanic/exalice.svg?branch=master)](https://travis-ci.org/kpanic/exalice)\n\n![Alice in wonderland!](/pic/alice-in-wonderland.png)\n\n**WARNING: This is alpha software, do not use in production!**\n\n## Installation of exalice from this repository\n\n  1. Ensure that Elasticsearch 6.4.0 is installed\n\n  2. Ensure that the analysis-icu plugin is installed:\n\n```bash\n# On Debian based systems\nsudo /usr/share/elasticsearch/bin/elasticsearch-plugin install analysis-icu\n```\n\n    The path of the `plugin` command varies between different operating systems\n\n  3. Ensure that Elasticsearch is started\n\n  4. Run the import (after fetching deps, and compiling everything):\n\n```bash\nmix exalice.bootstrap # Populate the storage with sample data in this repository\n```\n\n## When exalice is used as an external dependency in your application\n\n  1. Add exalice to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [{:exalice, \"~\u003e 0.0.7-alpha\"}]\nend\n```\n\n  2. Ensure that Elasticsearch 6.4.0 is installed\n\n  3. Ensure that the analysis-icu plugin is installed:\n\n```bash\nsudo /usr/share/elasticsearch/bin/elasticsearch-plugin install analysis-icu\n```\n\n    The path might vary between different operating systems\n\n  4. Ensure that Elasticsearch is started\n\n  5. Add to your config/config.exs:\n\n```elixir\nconfig :exalice,\n      provider: ExAlice.Geocoder.Providers.Elastic,\n      geocoder: ExAlice.Geocoder.Providers.OpenStreetMap,\n      index: :exalice,\n      doc_type: :location,\n      file: \"data/germany-streets.json\",\n      chunks: 5000\n```\n\n    The available options for the `geocoder:` are\n    `ExAlice.Geocoder.Providers.GoogleMaps` or\n    `ExAlice.Geocoder.Providers.OpenStreetMap`\n\n  7. (optional) Put a json file generated with [pbf2json](https://github.com/pelias/pbf2json) from openstreetmap pbf(s) in your `data/` folder\n\n  8. Copy the [germany-streets.json](https://github.com/kpanic/exalice/blob/master/data/germany-streets.json) sample extract in your local `data/` folder inside your application\n\n  9. Run `mix exalice.bootstrap`\n\n\n\n## To geocode an address execute:\n\n  1. Run `iex -S mix`\n\n  2. Type `ExAlice.Geocoder.geocode(\"Via Recoaro 3, Broni\")`\n\n  3. You should receive back data from the configured geocoder provider\n     (OpenStreetMap or Google Maps)\n\n  4. If you run again `ExAlice.Geocoder.geocode(\"Via Recoaro, Broni\")` you should receive back data from the storage (no external lookup)\n\n**NOTE**: At the moment the geocoder part that relies on google maps has no\npossibility to use a google maps api key.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkpanic%2Fexalice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkpanic%2Fexalice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkpanic%2Fexalice/lists"}