Skip to content

Commit

Permalink
Add All Contributors Specification (#100)
Browse files Browse the repository at this point in the history
* add .all-contributorsrc

Adds all-contributors bot
Updates README.md
Add link to emoji key
Change all-contributors link to documentation platform rather than github
  • Loading branch information
josee-sabourin authored May 3, 2023
1 parent b24ad71 commit eed12d0
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 17 deletions.
13 changes: 13 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"projectName": "gbfs-validator",
"projectOwner": "MobilityData",
"repoType": "github",
"repoHost": "https://github.com",
"files": ["README.md"],
"commit": false,
"imageSize": 100,
"contributorsPerLine": 7,
"contributorsSortAlphabetically": true,
"skipCi": true,
"contributors": []
}
44 changes: 27 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# GBFS-validator

[![All Contributors](https://img.shields.io/github/all-contributors/MobilityData/gbfs-validator?color=blue&style=flat)](#contributors)

A [General Bikeshare Feed Specification](https://github.com/MobilityData/gbfs) dataset validator

# Introduction
## Introduction

The 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).
It validates feeds up to GBFS version 2.3.
Expand All @@ -14,7 +16,7 @@ The schemas in `gbfs-validator/versions/schemas` is a git subtree of https://git

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

# Run the app
## Run the app

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

Expand All @@ -24,41 +26,35 @@ The validator is developed to be used “online” (hosted with a lambda functio
4. Select file requirement options (free-floating or docked)
5. Click the “Valid me” button, and see the validation results below

# Validation rules
## Validation rules

The validation rules are listed in [RULES.md](/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](/CONTRIBUTING.md) for details.

:warning: for contributions on schemas, please see [Versions README](gbfs-validator/versions/README.md)

# Build the project: Web server install procedure
## Build the project: Web server install procedure

## Required
### Required

To build the project locally, you need

- [Node.js](https://nodejs.org/en/download/) + [Yarn](https://classic.yarnpkg.com/en/docs/install/)

- Ports 8080, 9000 and 9229 need to be free

### Node.js
#### Node.js

We recommend you to use [NVM](https://github.com/nvm-sh/nvm#installing-and-updating)

Minimum Node.js version `v14.x.x`, or higher. Recommend Node.js version `v18.x.x`.

## Clone the repository
### Clone the repository

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

## Run dev environment
### Run dev environment

With Node.js

Expand All @@ -69,10 +65,24 @@ yarn start

Open `localhost:8080` on your browser

# Projects based on this validator
## Projects based on this validator

[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.

[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.
## Contributors

# Acknowledgements
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This 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.

:warning: for contributions on schemas, please see [Versions README](gbfs-validator/versions/README.md)
## Acknowledgements

This project was originally created by Pierrick Paul at [fluctuo](https://fluctuo.com/) - MobilityData started maintaining the project in September 2021.

0 comments on commit eed12d0

Please sign in to comment.