{"id":15592034,"url":"https://github.com/derhuerst/vbb-rest","last_synced_at":"2025-04-13T02:23:23.851Z","repository":{"id":35855680,"uuid":"40140481","full_name":"derhuerst/vbb-rest","owner":"derhuerst","description":"An HTTP API for Berlin \u0026 Brandenburg public transport.","archived":false,"fork":false,"pushed_at":"2025-03-18T13:22:09.000Z","size":352,"stargazers_count":135,"open_issues_count":8,"forks_count":12,"subscribers_count":4,"default_branch":"6","last_synced_at":"2025-04-04T06:37:14.859Z","etag":null,"topics":["api","berlin","bvg","transit","transport","vbb"],"latest_commit_sha":null,"homepage":"https://v6.vbb.transport.rest/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/derhuerst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","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},"funding":{"liberapay":"derhuerst","patreon":"derhuerst","github":"derhuerst"}},"created_at":"2015-08-03T18:13:40.000Z","updated_at":"2025-03-18T13:22:14.000Z","dependencies_parsed_at":"2023-11-07T19:33:05.846Z","dependency_job_id":"7a591ec3-cab7-434d-bbd6-c225c70b1910","html_url":"https://github.com/derhuerst/vbb-rest","commit_stats":{"total_commits":255,"total_committers":3,"mean_commits":85.0,"dds":0.0117647058823529,"last_synced_commit":"335e6e805fb5c9d3083a7e897d2d51fd3c11e39c"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fvbb-rest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fvbb-rest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fvbb-rest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fvbb-rest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/derhuerst","download_url":"https://codeload.github.com/derhuerst/vbb-rest/tar.gz/refs/heads/6","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248655012,"owners_count":21140408,"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":["api","berlin","bvg","transit","transport","vbb"],"created_at":"2024-10-02T23:53:18.029Z","updated_at":"2025-04-13T02:23:23.823Z","avatar_url":"https://github.com/derhuerst.png","language":"JavaScript","funding_links":["https://liberapay.com/derhuerst","https://patreon.com/derhuerst","https://github.com/sponsors/derhuerst"],"categories":[],"sub_categories":[],"readme":"# vbb-rest\n\n***vbb-rest* is a public transport REST API**, a clean alternative to the [VBB HAFAS API](https://github.com/public-transport/hafas-client/blob/6/p/vbb/readme.md).\n\n[**API documentation**](docs/readme.md)\n\n![vbb-rest architecture diagram](architecture.svg)\n\n[![API status](https://badgen.net/uptime-robot/status/m793274559-f7e6aec36412170133ab2b04)](https://stats.uptimerobot.com/57wNLs39M/793274559)\n![ISC-licensed](https://img.shields.io/github/license/derhuerst/vbb-rest.svg)\n[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)\n[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)\n\n\n## installing \u0026 running\n\n### access to Redis\n\nIt is recommended that you let `bvg-rest` cache HAFAS responses within a [Redis](https://redis.io/) cache. To use this feature, set `$REDIS_URL` (e.g. to `redis://localhost:6379/1` when running Redis locally).\n\n### via Docker\n\nA Docker image [is available as `derhuerst/vbb-rest:6`](https://hub.docker.com/r/derhuerst/vbb-rest:6).\n\n```shell\ndocker run -d -p 3000:3000 derhuerst/vbb-rest:6\n```\n\n*Note:* The Docker image does not contain the Redis server.\n\n### manually\n\n```shell\ngit clone https://github.com/derhuerst/vbb-rest.git\ncd vbb-rest\ngit checkout 6\nnpm install\n\nexport HOSTNAME='my-vbb-rest-api.example.org'\nnpm run build\n\nredis-server \u0026\nnpm start\n```\n\nTo keep the API running permanently, use tools like [`forever`](https://github.com/foreverjs/forever#forever) or [`systemd`](https://wiki.debian.org/systemd).\n\n\n## Related Projects\n\n- [`vbb-modules`](https://github.com/derhuerst/vbb-modules) – List of JavaScript modules for Berlin \u0026 Brandenburg public transport.\n- [`vbb-hafas`](https://github.com/public-transport/vbb-hafas) – JavaScript client for the BVG HAFAS API.\n- [`bvg-rest`](https://github.com/derhuerst/bvg-rest) – A clean REST API wrapping around the BVG API.\n- [`db-rest`](https://github.com/derhuerst/db-rest) – A clean REST API wrapping around the *Deutsche Bahn* API.\n- [`hvv-rest`](https://github.com/derhuerst/hvv-rest) – A clean REST API wrapping around the HVV API.\n- [`hafas-rest-api`](https://github.com/public-transport/hafas-rest-api) – Expose a HAFAS client via an HTTP REST API.\n- [`hafas-client`](https://github.com/public-transport/hafas-client) – JavaScript client for HAFAS public transport APIs.\n\n\n## Contributing\n\nIf you have a question or have difficulties using `vbb-rest`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/vbb-rest/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fvbb-rest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderhuerst%2Fvbb-rest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fvbb-rest/lists"}