hdk-core/README.md

# Hyperf Development Kit Core

The Common HDK for Any project by Hyperf.

> DEPRECATED!!!
> 
> This Branch is outdated, 
> only used for support old versions.
> Such as Hyperf 2.2 or less.
> 
> Please UPGRADE your version to Hyperf 3.0
> and HDK-Core 0.2.*

## PHP Versions

This version will work on Hyperf version 2.2 and above.

## Getting Started

PHP 8.0 or above and Composer is expected to be installed on our system.

### Installing Composer

For instructions on how to install Composer visit [getcomposer.org](https://getcomposer.org/download/).

### Installing

After cloning this repository, change into the newly created directory and run

```bash
composer config secure-http false \
&& composer config repo.lux-map composer https://satis.luxcreo.cn/ \
&& composer require singularity/hdk-core \
&& php bin/hyperf.php vendor:publish singularity/hdk-core
```

This will install all dependencies needed for the project.

## Running the Tests

All tests can be run by executing

```bash
composer test
```

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

## Built With

  - [PHP](https://secure.php.net/)
  - [Composer](https://getcomposer.org/)
  - [Hyperf](https://hyperf.wiki/2.2/)
  - [Pest](https://pestphp.com/) 

## License

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