https://github.com/fastybird/metadata-library

:card_index: [READ-ONLY] FastyBird metadata reader & validator for modules, plugins & etc. used by FastyBird applications
https://github.com/fastybird/metadata-library

constants enums fastybird fb json-schema metadata php typescript

Last synced: about 1 month ago
JSON representation

:card_index: [READ-ONLY] FastyBird metadata reader & validator for modules, plugins & etc. used by FastyBird applications

• Host: GitHub
• URL: https://github.com/fastybird/metadata-library
• Owner: FastyBird
• License: apache-2.0
• Created: 2020-11-24T21:02:13.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-19T11:33:52.000Z (3 months ago)
• Last Synced: 2024-10-28T12:11:35.789Z (2 months ago)
• Topics: constants, enums, fastybird, fb, json-schema, metadata, php, typescript
• Language: PHP
• Homepage:
• Size: 923 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG-1.0.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


	



# FastyBird metadata library

[![Build Status](https://flat.badgen.net/github/checks/FastyBird/metadata-library/main?cache=300&style=flat-square)](https://github.com/FastyBird/metadata-library/actions)

[![Licence](https://flat.badgen.net/github/license/FastyBird/metadata-library?cache=300&style=flat-square)](https://github.com/FastyBird/metadata-library/blob/main/LICENSE.md)

[![Code coverage](https://flat.badgen.net/coveralls/c/github/FastyBird/metadata-library?cache=300&style=flat-square)](https://coveralls.io/r/FastyBird/metadata-library)

[![Mutation testing](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FFastyBird%2Fmetadata-library%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/FastyBird/metadata-library/main)

![PHP](https://flat.badgen.net/packagist/php/FastyBird/metadata-library?cache=300&style=flat-square)

[![Latest stable](https://flat.badgen.net/packagist/v/FastyBird/metadata-library/latest?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/metadata-library)

[![Downloads total](https://flat.badgen.net/packagist/dt/FastyBird/metadata-library?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/metadata-library)

[![PHPStan](https://flat.badgen.net/static/PHPStan/enabled/green?cache=300&style=flat-square)](https://github.com/phpstan/phpstan)

![JS](https://flat.badgen.net/static/js/es6/blue?cache=300&style=flat-square)

[![JS downloads total](https://flat.badgen.net/npm/dt/@fastybird/metadata-library?cache=300&style=flat-square)](https://www.npmjs.com/package/@fastybird/metadata-library)

[![JS latest stable](https://flat.badgen.net/npm/v/@fastybird/metadata-library?cache=300&style=flat-square)](https://www.npmjs.com/package/@fastybird/metadata-library)

![Types](https://flat.badgen.net/npm/types/@fastybird/metadata-library?cache=300&style=flat-square)

***

## What is FastyBird metadata library?

This is library for [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) ecosystem which is

implementing [json schemas](https://json-schema.org) data validation helpers and is central place for application

constants.

## Installation

### PHP based project:

The best way to install **fastybird/metadata-library** is using [Composer](http://getcomposer.org/):

```sh

composer require fastybird/metadata-library

```

### JS based project:

The best way to install **@fastybird/metadata-library** is using [Yarn](https://yarnpkg.com/):

```sh

yarn add @fastybird/metadata-library

```

## Updating metadata

If you want to place your module, plugin, connector etc. here, feel free to create [pull request](https://github.com/FastyBird/fastybird/pulls) with your updates.

# FastyBird



	



FastyBird is an Open Source IOT solution built from decoupled components with powerful API and the highest quality code. Read more on [fastybird.com.com](https://www.fastybird.com).

## Documentation

Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).

## Contributing

The sources of this package are contained in the [FastyBird monorepo](https://github.com/FastyBird/fastybird). We welcome contributions for this package on [FastyBird/fastybird](https://github.com/FastyBird/).

## Feedback

Use the [issue tracker](https://github.com/FastyBird/fastybird/issues) for bugs

or [mail](mailto:[email protected]) or [Tweet](https://twitter.com/fastybird) us for any idea that can improve the

project.

Thank you for testing, reporting and contributing.

## Changelog

For release info check [release page](https://github.com/FastyBird/fastybird/releases).

## Maintainers

	

		

			

				

					

				

				


				Adam Kadlec

			

		

	

***

Homepage [https://www.fastybird.com](https://www.fastybird.com) and

repository [https://github.com/FastyBird/metadata-library](https://github.com/FastyBird/metadata-library).