PHP Package Skeleton / Example Project

This repository shows a basic setup for a PHP package or application in PHP.

Getting Started

All-in-one environment has been contained in this docker.

Installing

A standard php docker is necessary, then run the following command.

composer create-project \
  --repository=https://nest.doylee.cn/api/packages/HDK/composer \
  --remove-vcs -s alpha \
    singularity/hdk-skeleton:^1.0 \
    .

or if you have been cloned this repository, you can use the following

php composer.phar install

This will install all dependencies needed for the project.

Running the Tests

All tests can be run by executing

composer test

pest will automatically find all tests inside the tests/ directory and run them based on the configuration in the phpunit.xml file.

Running the Application

PHP has an in-built server for local development. This can be started by executing

composer start

Then open your browser at http://localhost:9561

You should see a json-format text on your screen.

Built With

• PHP
• Composer
• Pest
• Hyperf

License

This project is licensed under the MIT License - see the LICENCE.md file for details.