README

Description

A collection of model classes for position tracking.

Installation

Install using composer:

composer require xint0/position-tracking-models

Usage

Coming soon.

Support

• Gitlab issues: https://gitlab.com/xint0-open-source/position-tracking-models/-/issues
• Discord: https://discord.gg/AFRTzgvKsK

Roadmap

Add coordinate formatting.

Contributing

This package is open source, and you are encouraged to contribute by:

• Reporting an issue through any of the following channels:
  • Gitlab issues: https://gitlab.com/xint0-open-source/position-tracking-models/-/issues
• Creating a fork of the project and submitting a merge request in https://gitlab.com/xint0-open-source/position-tracking-models/-/merge_requests/new.

Working with the code

The project uses Docker Compose to define containers used for development. Although it is not necessary to use Docker, it makes working with multiple versions of PHP easier.

Docker images

The PHP docker image includes XDebug extension, composer, and phive. It is built from currently supported PHP versions: 8.4.

The PHPStan docker image includes PHPUnit plugin, and it is built using PHP 8.4.

After forking and cloning the git repository to your local environment, you can execute the following docker compose commands:

Install development tools

The project uses PHPUnit for testing, PHPStan for static analysis, PHPCodeSniffer and PHP Code Beautifier and Fixer for linting. These tools are installed using Phive.

docker compose run --rm php phive install

Execute tests

After installing the development tools, to execute the tests:

docker compose run --rm php tools/phpunit

Authors

This package was created and is maintained by Rogelio Jacinto (@Xint0).

License

This package is open source software licensed under the MIT License.