{"id":15058973,"url":"https://github.com/giscience/openrouteservice-app","last_synced_at":"2025-04-06T20:13:46.143Z","repository":{"id":10457302,"uuid":"65813563","full_name":"GIScience/openrouteservice-app","owner":"GIScience","description":":blue_car: The open source route planner app with plenty of features.","archived":false,"fork":false,"pushed_at":"2023-01-18T07:32:20.000Z","size":4352,"stargazers_count":227,"open_issues_count":8,"forks_count":53,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-04-06T20:13:39.193Z","etag":null,"topics":["angularjs","api","maps","openrouteservice","opensource","openstreetmap","routing"],"latest_commit_sha":null,"homepage":"https://maps.openrouteservice.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GIScience.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2016-08-16T11:09:10.000Z","updated_at":"2025-01-23T16:57:25.000Z","dependencies_parsed_at":"2023-02-10T13:46:39.970Z","dependency_job_id":null,"html_url":"https://github.com/GIScience/openrouteservice-app","commit_stats":null,"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fopenrouteservice-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fopenrouteservice-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fopenrouteservice-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fopenrouteservice-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GIScience","download_url":"https://codeload.github.com/GIScience/openrouteservice-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247543595,"owners_count":20955865,"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":["angularjs","api","maps","openrouteservice","opensource","openstreetmap","routing"],"created_at":"2024-09-24T22:34:43.197Z","updated_at":"2025-04-06T20:13:46.117Z","avatar_url":"https://github.com/GIScience.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Classic openrouteservice maps client\n\n[![status: archive](https://github.com/GIScience/badges/raw/master/status/archive.svg)](https://github.com/GIScience/badges#archive) [![Build Status](https://travis-ci.org/GIScience/openrouteservice-app.svg?branch=development)](https://travis-ci.org/GIScience/openrouteservice-app)\n\nThe classic openrouteservice(ors) maps client is an online route planning application that is based on open source software, open data and open standards.\n\nIt uses the [openrouteservice API](https://openrouteservice.org/) and needs a valid API key\n(free up to a [certain request limit per day](https://openrouteservice.org/plans/))\n\n![preview](https://cloud.githubusercontent.com/assets/10322094/26202903/63ccd808-3bd9-11e7-9a89-f06ad50d583e.png)\n\n## Installation\n\nRequirements:\n- [git](https://git-scm.com/downloads)\n- docker\n- docker-compose\n\nClone the repository\n```sh\ngit clone https://github.com/GIScience/openrouteservice-app.git\n\n# switch to repository folder\ncd openrouteservice-app\n```\n\nFirst Replace weathercheck.txt content with your Api-Key:\n```sh\n# Open `app/weathercheck.txt` in your favorite text editor and replace the content with your Token.\n# e.g.:\nvim app/weathercheck.txt\n```\n\nBuild the docker image:\n```\ndocker-compose build\n```\n## Running the client\n\nRun docker-compose up:\n```\ndocker-compose up -d\n```\n\nThe app will be exposed on http://localhost:8035\n\n## Running in development mode\n- open on http://localhost:3005\n- container will be removed after stopping\n\nNormal endpoints:\n```\ndocker-compose run -p 3005:3005 --rm ors-classic-maps dev\n```\n\nIf you want to use the openrouteservice client with a\n[local backend version of openrouteservice](https://github.com/GIScience/openrouteservice) make sure\nyou are using the correct *endpoint paths* in `ngconstant.local` of the `Grunfile.sample.js`.\n\nLocal ors backend:\n```\ndocker-compose run -p 3005:3005 --rm ors-classic-maps ors_local\n```\n\n\u003e Note: In case of CORS issues try setting the endpoints of the backend services to `http://localhost:3005`\n\u003e which should be proxied to `http://localhost:8082` by the `connect:dev` grunt task.\n\n## Install dependencies locally\n\nIf you want to have all dependencies locally, installation is a bit more difficult.\nAlso, the commands for running the client are a bit different.\n\nRequirements:\n\n- [git](https://git-scm.com/downloads)\n- [nodejs](https://nodejs.org/en/download/package-manager/)\n- [Api-key](https://openrouteservice.org/sign-up/)\n\n### Permission Issues\nIf you encounter any [permission issues](https://github.com/npm/npm/issues/18380) during the installation:\n\n- *on Linux:* try running npm-commands with `sudo` :\n\ne.g.:\n```sh\nsudo npm install\n```\n- *on Windows([GitBash](https://gitforwindows.org/) recommended):* try running npm-commands with the `--no-optional` flag:\n\ne.g.:\n```sh\nnpm install --no-optional\n```\n\n### Installation\n\nAfter cloning the repository:\n\n- Install dependencies:\n```sh\n# install all modules listed as dependencies in package.json\nnpm install\n```\n\n- Initiate default files:\n```sh\n# Copy `Gruntfile.default.js` to `Gruntfile.js`\ncp Gruntfile.default.js Gruntfile.js\n\n# Copy `weathercheck.default.txt` to `weathercheck.txt`\ncp app/weathercheck.default.txt app/weathercheck.txt\n```\n\nDon't forget to edit `weathercheck.txt` and insert your API key.\n\n### Run openrouteservice:\n\nTo enable console output information and logging for bug-fixing and feature development do:\n\n\tgrunt dev\n\nTo build for production (all output in `build` folder):\n\n\tgrunt ors\n\nTo use a local ors backend:\n\n\tgrunt ors_local\n\n## Contribution\n\nIf you would like to contribute, please note that we are using a [branching model](http://nvie.com/posts/a-successful-git-branching-model/) to structure our git workflow and are following [commit message guidelines](https://api.coala.io/en/latest/Developers/Writing_Good_Commits.html).\n\nFor minor bugfixes use the development branch:\n\n\tgit checkout development\n\nFor new features, please create a new branch:\n\n\tgit checkout -b feature_branch\n\nDo a [pull request](https://help.github.com/articles/creating-a-pull-request/) to our development branch.\nBe sure to pull the latest changes beforehand and fix any emerging conflicts.\n\n## Translations\n\nHelp us to provide the openrouteservice in your language by translating some simple keywords!\n\nIn this [spreadsheet](https://docs.google.com/spreadsheets/d/1GzFPlVrqJBmUatfWft7v-vS_tfENGtAy0RHOv_5n3SU/edit#gid=0) you can add a column for your language or check the already added words if they are correctly translated. Our service will be updated regularly with the latest language versions.\n\nIf there are further questions, please let us know!\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2017 GIScience Research Group, Heidelberg University.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiscience%2Fopenrouteservice-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgiscience%2Fopenrouteservice-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiscience%2Fopenrouteservice-app/lists"}