https://github.com/maasglobal/maas-schemas

Mobility as a Service API - data model, tests, and validation
https://github.com/maasglobal/maas-schemas

mobility mobility-as-a-service transportation

Last synced: 2 months ago
JSON representation

Mobility as a Service API - data model, tests, and validation

• Host: GitHub
• URL: https://github.com/maasglobal/maas-schemas
• Owner: maasglobal
• License: mit
• Created: 2016-07-21T10:39:44.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2023-12-18T11:03:04.000Z (7 months ago)
• Last Synced: 2023-12-19T01:03:12.384Z (7 months ago)
• Topics: mobility, mobility-as-a-service, transportation
• Language: TypeScript
• Homepage: https://maasglobal.github.io/
• Size: 12.1 MB
• Stars: 17
• Watchers: 22
• Forks: 33
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• open-sustainable-technology - MaaS Global - Mobility as a Service API - data model, tests and validation. (Consumption / Mobility and Transportation)

README

        
# Shared MaaS Global Type Definitions

This repository contains MaaS Global shared type definitions.

## Index

The code is divided into several independent npm packages.

* [maas-schemas](maas-schemas) contains schemas, type definitions, and related utilities

* [maasglobal-json-schema-validator](maasglobal-json-schema-validator) contains our ajv validator configuration

* [maasglobal-schema-generator-ajv](maasglobal-schema-generator-ajv) contains build utils for ensuring ajv compatibility

* [maasglobal-schema-generator-io-ts](maasglobal-schema-generator-io-ts) contains build utils for generating io-ts codecs

* [maasglobal-schema-package](maasglobal-schema-package) contains general definitions for our schema package format

## Devops

The following commands should work in all packages where applicable.

```

npm install -g yarn               # install yarn

yarn                              # install dependencies

yarn lint                         # run linters

yarn typecheck                    # run static type checks

yarn test                         # run tests

yarn prettify                     # auto format code base

yarn ci                           # perform a local CI test run

yarn build                        # create a production build

yarn clean                        # remove build artefacts

yarn readme-ts                    # extract readme code examples

yarn deploy-npm                   # deploy npm package

yarn deploy-alpha                 # deploy prelease npm package

```