testower/gbfs-validator

A GBFS feed validator

GBFS-validator

A General Bikeshare Feed Specification dataset validator

Introduction

The Canonical GBFS Validator is a tool to check the conformity of a GBFS feed against the official specification. It validates feeds up to GBFS version 2.3-RC. This tool is built using the JSON Schemas, and the site is powered by Netlify.

The schemas on versions/schemas is a git subtree of https://github.com/MobilityData/gbfs-json-schema. See README.md on versions for more details

Questions? Please open an issue or reach out to MobilityData on the GBFS slack channel!

Run the app

The validator is developed to be used “online” (hosted with a lambda function).

1. Open gbfs-validator.netlify.com/
2. Enter the feed’s auto-discovery URL
3. If needed, select the version. If not specified, the validator will pick the version mentioned in the gbfs.json file
4. Select file requirement options (free-floating or docked)
5. Click the “Valid me” button, and see the validation results below

Validation rules

The validation rules are listed in RULES.md Have a suggestion for a new rule? Open an issue!

Contributing

We welcome contributions to the project! Please check out our Contribution guidelines for details.

⚠️ for contributions on schemas, please see Versions README

Build the project: Web server install procedure

Required

To build the project locally, you need

• Node.js + Yarn

• Ports 8080, 9000 and 9229 need to be free

Node.js

We recommend you to use NVM

You should use v12.x.x of Node.js, or higher. We recommend v14.x.x.

Clone the repository

git clone https://github.com/fluctuo/gbfs-validator.git
cd gbfs-validator

Run dev environment

With Node.js

yarn
yarn start

Open localhost:8080 on your browser

Acknowledgements

This project was originally created by Pierrick Paul at fluctuo - MobilityData started maintaining the project in September 2021.