Download the PHP package elliotjreed/gfs-tracking without Composer
On this page you can find all versions of the php package elliotjreed/gfs-tracking. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elliotjreed/gfs-tracking
More information about elliotjreed/gfs-tracking
Files in elliotjreed/gfs-tracking
Package gfs-tracking
Short Description A PHP package for returning tracking / consignment information from GFS
License MIT
Homepage https://github.com/elliotjreed/gfs-tracking
Informations about the package gfs-tracking
gfs-tracking
Getting Started
PHP 8.3 or above and Composer is expected to be installed.
Installing Composer
For instructions on how to install Composer visit getcomposer.org.
Installing
After cloning this repository, change into the newly created directory and run:
or if you have installed Composer locally in your current directory:
This will install all dependencies needed for the project.
Henceforth, the rest of this README will assume composer
is installed globally (ie. if you are using composer.phar
you will need to use composer.phar
instead of composer
in your terminal / command-line).
Running the Tests
Unit tests
Unit testing in this project is via PHPUnit.
All unit tests can be run by executing:
Debugging
To have PHPUnit stop and report on the first failing test encountered, run:
Code formatting
A standard for code style can be important when working in teams, as it means that less time is spent by developers processing what they are reading (as everything will be consistent).
Code formatting is automated via PHP-CS-Fixer. PHP-CS-Fixer will not format line lengths which do form part of the PSR-2 coding standards so these will product warnings when checked by PHP Code Sniffer.
These can be run by executing:
Running everything
All of the tests can be run by executing:
Outdated dependencies
Checking for outdated Composer dependencies can be performed by executing:
Validating Composer configuration
Checking that the composer.json is valid can be performed by executing:
Running via GNU Make
If GNU Make is installed, you can replace the above composer
command prefixes with make
.
All of the tests can be run by executing:
Running the tests on a Continuous Integration platform (eg. Github Actions)
Specific output formats better suited to CI platforms are included as Composer scripts.
To output unit test coverage in text and Clover XML format (which can be used for services such as Coveralls):
To output PHP-CS-Fixer (dry run) and PHPCS results in checkstyle format (which GitHub Actions will use to output a readable format):
Github Actions
Look at the example in .github/workflows/main.yml.
Built With
License
This project is licensed under the MIT License - see the LICENCE.md file for details.