{"id":28120672,"url":"https://github.com/mobilitydata/gbfs-validator","last_synced_at":"2025-05-14T07:42:39.081Z","repository":{"id":38417568,"uuid":"153654428","full_name":"MobilityData/gbfs-validator","owner":"MobilityData","description":"The canonical GBFS validator. Maintained by the GBFS community, facilitated by MobilityData.","archived":false,"fork":false,"pushed_at":"2025-03-13T19:13:23.000Z","size":4510,"stargazers_count":19,"open_issues_count":33,"forks_count":12,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-11T17:56:25.986Z","etag":null,"topics":["bike","bikeshare","bikesharing","gbfs"],"latest_commit_sha":null,"homepage":"https://gbfs-validator.mobilitydata.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/MobilityData.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2018-10-18T16:27:52.000Z","updated_at":"2025-03-13T19:13:25.000Z","dependencies_parsed_at":"2023-09-24T05:09:22.220Z","dependency_job_id":"2f9f67c6-c4d5-4ba6-951b-a6ed13a5a55c","html_url":"https://github.com/MobilityData/gbfs-validator","commit_stats":{"total_commits":164,"total_committers":19,"mean_commits":8.631578947368421,"dds":0.7134146341463414,"last_synced_commit":"6f1bcd9759ce501207542c396d6baf260ebf9390"},"previous_names":["pierrickp/gbfs-validator"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MobilityData%2Fgbfs-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MobilityData%2Fgbfs-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MobilityData%2Fgbfs-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MobilityData%2Fgbfs-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MobilityData","download_url":"https://codeload.github.com/MobilityData/gbfs-validator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254096617,"owners_count":22014059,"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":["bike","bikeshare","bikesharing","gbfs"],"created_at":"2025-05-14T07:41:31.256Z","updated_at":"2025-05-14T07:42:39.068Z","avatar_url":"https://github.com/MobilityData.png","language":"JavaScript","readme":"# GBFS-validator\n\n[![All Contributors](https://img.shields.io/github/all-contributors/MobilityData/gbfs-validator?color=blue\u0026style=flat)](#contributors)\n\nA [General Bikeshare Feed Specification](https://github.com/MobilityData/gbfs) dataset validator\n\n## Introduction\n\nThe Canonical GBFS Validator is a tool to check the conformity of a GBFS feed against the [official specification](https://github.com/MobilityData/gbfs/blob/master/gbfs.md).\nIt validates feeds up to GBFS version 3.0.\nThis tool is built using the [JSON Schemas](https://github.com/MobilityData/gbfs-json-schema), and the site is powered by [Netlify](https://www.netlify.com/).\n\n![interface](https://github.com/MobilityData/gbfs-validator/assets/2423604/11206e7a-dd64-4133-bb32-eaa391815e60)\n\nThe schemas in `gbfs-validator/versions/gbfs-json-schema` is a git submodule of https://github.com/MobilityData/gbfs-json-schema.\n\nQuestions? Please open an issue or reach out on the #gbfs channel on the [MobilityData Slack](https://mobilitydata-io.slack.com/).\n\n## Run the app\n\nThe validator is developed to be used “online” (hosted with a lambda function).\n\n1.  Open https://gbfs-validator.mobilitydata.org\n2.  Enter the feed’s auto-discovery URL\n3.  If needed, select the version. If not specified, the validator will pick the version mentioned in the `gbfs.json` file\n4.  Select file requirement options (free-floating or docked)\n5.  Click the “Validate me !” button, and see the validation results below\n\n## Validation rules\n\nThe validation rules are listed in [RULES.md](/RULES.md)\nHave a suggestion for a new rule? Open an issue!\n\n## Build the project: Web server install procedure\n\n### Required\n\nTo build the project locally, you need:\n\n- [Node.js](https://nodejs.org/en/download/). Minimum Node.js version `v14.x.x`, or higher. Recommend Node.js version `v18.x.x`.\n```shell\nbrew install node\n```\n\n- [Yarn](https://classic.yarnpkg.com/en/docs/install/)\n```shell\nnpm install --global yarn\n```\n\n- Ports 8080, 9000 and 9229 need to be free\n\n### Run dev environment\n\n- Download or clone the repository\n```shell\ngit clone https://github.com/MobilityData/gbfs-validator.git\ncd gbfs-validator\n```\n\n- Install the requirements\n```shell\nyarn\n```\n\n- Connect your local project to the `gbfs-validator` Netlify site to access its environment variables\n```shell\nnetlify link\n```\nSelect `Enter the site name` and enter `gbfs-validator`\n\n- Run dev environment locally\n```shell\nyarn run dev\n```\n\n- Open `localhost:8080` on your browser\n\n### Command line\nThe GBFS validator can be used as a Command Line Interface (CLI):\n\n- Download or clone the repository\n```shell\ngit clone https://github.com/MobilityData/gbfs-validator.git\ncd gbfs-validator\n```\n\n- Execute the CLI script\n```shell\nnode ./gbfs-validator/cli.js -u {http_address_of_gbfs_dataset} -s {local_path_to_output_report_file}\n```\n\n- To get the list of supported paramters\n```shell\nnode ./gbfs-validator/cli.js --help\n```\n\n- Usage description and supported parameters\n```\nUsage: cli [OPTIONS]...\n\nOptions:\n  -v, --version                    output the version number\n  -u, --url \u003cfeed_url\u003e             URL of the GBFS feed\n  -vb, --verbose                   Verbose mode prints debugging console logs\n  -s, --save-report \u003creport_path\u003e  Local path to output report file\n  -pr, --print-report \u003cyes_no\u003e     Print report to standard output (choices: \"yes\", \"no\", default: \"yes\")\n  -h, --help                       display help for command\n```\n\n### Npm package\nThe gbfs-validator Node.js npm package is now accessible for integration into your projects. To learn how to install and utilize it effectively, please refer to the [README](./gbfs-validator/README.md) for comprehensive guidance.\n\n## Projects based on this validator\n\n[transport.data.gouv.fr GBFS validator tool](https://transport.data.gouv.fr/validation?type=gbfs) - Tool displaying interactive geofencing, station, and vehicle maps, the validation results, and metadata of GBFS feeds.\n\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://allcontributors.org/docs/en/overview) specification, find the [emoji key here](https://allcontributors.org/docs/en/emoji-key). Contributions of any kind welcome! Please check out our [Contribution guidelines](/CONTRIBUTING.md) for details.\n\n:warning: for contributions on schemas, please see [Versions README](gbfs-validator/versions/README.md)\n\n## OpenAPI Specification\n\n:warning: **Subject to change**: This OpenAPI specification may change at any time. We do not recommend building any production systems that depend on this API directly.\n\nThe OpenAPI specification can be viewed at: https://mobilitydata.github.io/gbfs-validator/SwaggerUI/index.html.\n\n## Acknowledgments\n\nThis project was originally created by Pierrick Paul ([@PierrickP](https://github.com/PierrickP)) at [fluctuo](https://fluctuo.com/) - MobilityData started maintaining the project in September 2021.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmobilitydata%2Fgbfs-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmobilitydata%2Fgbfs-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmobilitydata%2Fgbfs-validator/lists"}