hyperf/hyperf-skeleton

A coroutine framework that focuses on hyperspeed and flexible, specifically use for build microservices and middlewares.

v3.1.2 2024-03-26 03:13 UTC

Requires

• php: >=8.1
• hyperf/cache: ~3.1.0
• hyperf/command: ~3.1.0
• hyperf/config: ~3.1.0
• hyperf/db-connection: ~3.1.0
• hyperf/engine: ^2.10
• hyperf/framework: ~3.1.0
• hyperf/guzzle: ~3.1.0
• hyperf/http-server: ~3.1.0
• hyperf/logger: ~3.1.0
• hyperf/memory: ~3.1.0
• hyperf/process: ~3.1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• hyperf/devtool: ~3.1.0
• hyperf/testing: ~3.1.0
• mockery/mockery: ^1.0
• phpstan/phpstan: ^1.0
• swoole/ide-helper: ^5.0

Suggests

• ext-json: Required to use JSON.
• ext-openssl: Required to use HTTPS.
• ext-pdo: Required to use MySQL Client.
• ext-pdo_mysql: Required to use MySQL Client.
• ext-redis: Required to use Redis Client.

Apache-2.0

• framework
• php
• middleware
• Microservice
• swoole
• hyperf

README

This is a skeleton application using the Hyperf framework. This application is meant to be used as a starting place for those looking to get their feet wet with Hyperf Framework.

Requirements

Hyperf has some requirements for the system environment, it can only run under Linux and Mac environment, but due to the development of Docker virtualization technology, Docker for Windows can also be used as the running environment under Windows.

The various versions of Dockerfile have been prepared for you in the hyperf/hyperf-docker project, or directly based on the already built hyperf/hyperf Image to run.

When you don't want to use Docker as the basis for your running environment, you need to make sure that your operating environment meets the following requirements:

• PHP >= 8.1
• Any of the following network engines
  • Swoole PHP extension >= 5.0，with swoole.use_shortname set to Off in your php.ini
  • Swow PHP extension >= 1.3
• JSON PHP extension
• Pcntl PHP extension
• OpenSSL PHP extension （If you need to use the HTTPS）
• PDO PHP extension （If you need to use the MySQL Client）
• Redis PHP extension （If you need to use the Redis Client）
• Protobuf PHP extension （If you need to use the gRPC Server or Client）

Installation using Composer

The easiest way to create a new Hyperf project is to use Composer. If you don't have it already installed, then please install as per the documentation.

To create your new Hyperf project:

composer create-project hyperf/hyperf-skeleton path/to/install

If your development environment is based on Docker you can use the official Composer image to create a new Hyperf project:

docker run --rm -it -v $(pwd):/app composer create-project --ignore-platform-reqs hyperf/hyperf-skeleton path/to/install

Getting started

Once installed, you can run the server immediately using the command below.

cd path/to/install
php bin/hyperf.php start

Or if in a Docker based environment you can use the docker-compose.yml provided by the template:

cd path/to/install
docker-compose up

This will start the cli-server on port 9501, and bind it to all network interfaces. You can then visit the site at http://localhost:9501/ which will bring up Hyperf default home page.

Hints

• A nice tip is to rename hyperf-skeleton of files like composer.json and docker-compose.yml to your actual project name.
• Take a look at config/routes.php and app/Controller/IndexController.php to see an example of a HTTP entrypoint.

Remember: you can always replace the contents of this README.md file to something that fits your project description.