{"id":20114915,"url":"https://github.com/vroom-project/vroom-express","last_synced_at":"2025-04-09T06:09:51.632Z","repository":{"id":41207620,"uuid":"59989298","full_name":"VROOM-Project/vroom-express","owner":"VROOM-Project","description":"Out of the box Node-express server to use VROOM as a web API.","archived":false,"fork":false,"pushed_at":"2025-03-11T15:04:38.000Z","size":121,"stargazers_count":71,"open_issues_count":8,"forks_count":61,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T04:05:47.763Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VROOM-Project.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-30T07:24:35.000Z","updated_at":"2025-03-11T15:04:42.000Z","dependencies_parsed_at":"2024-11-19T21:15:24.590Z","dependency_job_id":"f31db4bf-68e5-43a0-a663-293895b7840b","html_url":"https://github.com/VROOM-Project/vroom-express","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VROOM-Project%2Fvroom-express","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VROOM-Project%2Fvroom-express/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VROOM-Project%2Fvroom-express/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VROOM-Project%2Fvroom-express/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VROOM-Project","download_url":"https://codeload.github.com/VROOM-Project/vroom-express/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987285,"owners_count":21028895,"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-11-13T18:33:03.159Z","updated_at":"2025-04-09T06:09:51.607Z","avatar_url":"https://github.com/VROOM-Project.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Requirements\n\n- Access to a routing engine ([OSRM](https://github.com/Project-OSRM/osrm-backend/wiki/Building-OSRM) or [OpenRouteService](https://github.com/GIScience/openrouteservice/))\n- [VROOM](https://github.com/VROOM-Project/vroom/wiki/Building)\n\n# Setup\n\n- Clone the repo\n\n```bash\ngit clone https://github.com/VROOM-Project/vroom-express.git\ncd vroom-express\ngit checkout v0.12.0\n```\n\n- Install dependencies using `npm`\n\n```bash\nnpm install\n```\n\n# Usage\n\nRun the server using:\n\n```bash\nnpm start\n```\n\nHealth check should now return a `200` HTTP status code:\n\n```bash\ncurl -w \"%{http_code}\" http://localhost:3000/health\n200\n```\n\nProvided everything is fine with your VROOM and routing setup, you\nshould now be able to run queries like:\n\n```bash\ncurl --header \"Content-Type:application/json\" --data '{\"vehicles\":[{\"id\":0,\"start\":[2.3526,48.8604],\"end\":[2.3526,48.8604]}],\"jobs\":[{\"id\":0,\"location\":[2.3691,48.8532]},{\"id\":1,\"location\":[2.2911,48.8566]}],\"options\":{\"g\":true}}' http://localhost:3000\n```\n\nSee the\n[API documentation](https://github.com/VROOM-Project/vroom/blob/master/docs/API.md)\nfor input syntax.\n\n# Customization\n\n## Server side\n\nAdjust `config.yml` to your needs.\n\nOptionally set `VROOM_ROUTER=\u003crouter\u003e`, `router` being `osrm` (default), `libosrm`, `ors` or `valhalla`. Using the environment variable **will override the config.yml `router` setting**.\n\n## Client side\n\nIf `override` is set to `true` in `config.yml`, then the `vroom` command-line parameters `-g`, `-c`, `-t`, `-x` and `-l` can be set dynamically per request in order to add detailed route geometry and indicators, run in plan mode, set the number of threads, set the exploration level and limit the solving time.\n\nSet values in the json payload via the `options` key:\n\n```json\n\"options\": {\n  \"g\": true,\n  \"c\": true,\n  \"t\": 4,\n  \"x\": 5,\n  \"l\": 10\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvroom-project%2Fvroom-express","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvroom-project%2Fvroom-express","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvroom-project%2Fvroom-express/lists"}