{"id":13424384,"url":"https://github.com/hiposfer/kamal","last_synced_at":"2025-03-15T18:34:53.985Z","repository":{"id":62432938,"uuid":"94440635","full_name":"hiposfer/kamal","owner":"hiposfer","description":"A routing engine service using Open Street Maps and GTFS as data source","archived":true,"fork":false,"pushed_at":"2019-06-21T17:40:48.000Z","size":1140,"stargazers_count":11,"open_issues_count":27,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-06T09:46:07.915Z","etag":null,"topics":["clojure","dijkstra","gtfs","osm","routing","transit"],"latest_commit_sha":null,"homepage":"","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hiposfer.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":"2017-06-15T13:10:51.000Z","updated_at":"2023-08-03T01:21:10.000Z","dependencies_parsed_at":"2022-11-01T21:01:13.358Z","dependency_job_id":null,"html_url":"https://github.com/hiposfer/kamal","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiposfer%2Fkamal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiposfer%2Fkamal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiposfer%2Fkamal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiposfer%2Fkamal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hiposfer","download_url":"https://codeload.github.com/hiposfer/kamal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243775834,"owners_count":20346274,"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":["clojure","dijkstra","gtfs","osm","routing","transit"],"created_at":"2024-07-31T00:00:53.555Z","updated_at":"2025-03-15T18:34:48.975Z","avatar_url":"https://github.com/hiposfer.png","language":"Clojure","funding_links":[],"categories":["Clojure"],"sub_categories":[],"readme":"# kamal [![Build Status](https://travis-ci.org/hiposfer/kamal.svg?branch=master)](https://travis-ci.org/hiposfer/kamal) [![Clojars Project](https://img.shields.io/clojars/v/hiposfer/kamal.svg)](https://clojars.org/hiposfer/kamal)\n\nA routing engine and API service based on Open data. Its current focus are flexibility,\nspeed and stability in that order.\n\n\n## Usage\nCheck out the [API examples](resources/kamal.postman_collection.json) provided as a [Postman](getpostman.com) collection.\nSimply import it and have fun :)\n\nFor a demo see [try.hyposfer.com](http://try.hiposfer.com/index.html)\n(it will take a few seconds on the first run).\n \nBy default `kamal` will run at [localhost:3000](http://localhost:3000).\n\n## Installation\nYou can install `kamal` from _clojars_ using _lein_ or use our _docker_ image.\n\n### Leiningen\n```\n$ git clone https://github.com/hiposfer/kamal.git \u0026\u0026 cd kamal\n\n## set up environment variables\n$ export FRANKFURT_AREA_NAME=\"Frankfurt am Main\"\n$ export FRANKFURT_AREA_GTFS=resources/test/frankfurt.gtfs.zip\n\n## preprocess input data -\u003e output to ./resources/test\n$ lein run -m hiposfer.kamal.preprocessor\n\n## compile application - you can run it with lein as well\n$ lein with-profile release uberjar\n\nexport FRANKFURT_AREA_EDN resources/test/frankfurt.edn.gz\n$ java -jar target/kamal.jar\n```\n\n### Docker\nUse our latest docker image:\n\n    $ ## setup env vars like above and pass them to docker\n    $ docker run -it -p 3000:3000 hiposfer/kamal\n\n## Development\nWe follow [Stuart Sierra's reload workflow](https://github.com/stuartsierra/component).\nOur system configuration is created by reading the environment variables. An example\nof such config can be found in `hiposfer.kamal.dev/env`. As you can see there, it is\nalso possible to create a system by providing the configuration directly.\n\n1. Start a REPL\n2. Load the `hiposfer.kamal.dev` namespace\n3. Run the `hiposfer.kamal.dev/refresh!` function\n4. Perform your changes\n    - if your changes modify the network build process. Repeat from `3.` \n    - keep making your changes in the repl otherwise\n\nIn other words:\n```\n$ git clone https://github.com/hiposfer/kamal.git \u0026\u0026 cd kamal\n$ lein repl\nhiposfer.kamal.core=\u003e (use 'hiposfer.kamal.dev)\nhiposfer.kamal.core=\u003e (hiposfer.kamal.dev/refresh!)\n```\nAnd then browse to [localhost:3000](http://localhost:3000)\n\n## OSM Files\n`kamal` consumes General Transit Feed Specification (GTFS) and Open Street Map files.\n\n`kamal` is very routing oriented, thus we rely on the awesome Overpass-API for\nfiltering of Open Street Map data. Check out our `pedestrian` filtering query\n[Here](resources/osm/overpass-api-query.txt). \n\nYou can customize it however you want; once you are done, simply save the query run the\npreprocessing script again with `lein preprocess resources/`. This will preprocess\nall gtfs configs in your environment variables with (automatically) downloaded osm data.\n\n## License\n`kamal` is distributed under LGPL v3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiposfer%2Fkamal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiposfer%2Fkamal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiposfer%2Fkamal/lists"}