PHPackages                             hyperf/hyperf-skeleton - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. hyperf/hyperf-skeleton

ActiveProject[Framework](/categories/framework)

hyperf/hyperf-skeleton
======================

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

v3.1.3(3mo ago)301187.4k↓13.1%131[2 issues](https://github.com/hyperf/hyperf-skeleton/issues)Apache-2.0PHPPHP &gt;=8.1CI passing

Since Jun 20Pushed 2mo ago12 watchersCompare

[ Source](https://github.com/hyperf/hyperf-skeleton)[ Packagist](https://packagist.org/packages/hyperf/hyperf-skeleton)[ Fund](https://hyperf.wiki/#/zh-cn/donate)[ Fund](https://opencollective.com/hyperf)[ RSS](/packages/hyperf-hyperf-skeleton/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (18)Versions (43)Used By (0)

Introduction
============

[](#introduction)

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
============

[](#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](https://github.com/hyperf/hyperf-docker) project, or directly based on the already built [hyperf/hyperf](https://hub.docker.com/r/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 &gt;= 8.1
- Any of the following network engines
    - Swoole PHP extension &gt;= 5.0，with `swoole.use_shortname` set to `Off` in your `php.ini`
    - Swow PHP extension &gt;= 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
===========================

[](#installation-using-composer)

The easiest way to create a new Hyperf project is to use [Composer](https://getcomposer.org/). If you don't have it already installed, then please install as per [the documentation](https://getcomposer.org/download/).

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
===============

[](#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
-----

[](#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.

###  Health Score

66

—

FairBetter than 99% of packages

Maintenance83

Actively maintained with recent releases

Popularity54

Moderate usage in the ecosystem

Community31

Small or concentrated contributor base

Maturity80

Battle-tested with a long release history

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~62 days

Recently: every ~206 days

Total

40

Last Release

73d ago

Major Versions

v1.1.4 → v2.0.02020-06-21

2.2.x-dev → v3.0.02022-08-18

PHP version history (5 changes)v1.0.0PHP &gt;=7.2

v2.1.0PHP &gt;=7.3

v2.2.4PHP &gt;=8.0

v3.1.0PHP &gt;=8.1

v3.2.0-alphaPHP &gt;=8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/44228082?v=4)[Hyperf Community](/maintainers/hyperf)[@hyperf](https://github.com/hyperf)

---

Top Contributors

[![limingxinleo](https://avatars.githubusercontent.com/u/16648551?v=4)](https://github.com/limingxinleo "limingxinleo (205 commits)")[![huangzhhui](https://avatars.githubusercontent.com/u/12077148?v=4)](https://github.com/huangzhhui "huangzhhui (165 commits)")[![sy-records](https://avatars.githubusercontent.com/u/33931153?v=4)](https://github.com/sy-records "sy-records (12 commits)")[![daydaygo](https://avatars.githubusercontent.com/u/3986303?v=4)](https://github.com/daydaygo "daydaygo (7 commits)")[![assert6](https://avatars.githubusercontent.com/u/28561563?v=4)](https://github.com/assert6 "assert6 (6 commits)")[![huangdijia](https://avatars.githubusercontent.com/u/8337659?v=4)](https://github.com/huangdijia "huangdijia (6 commits)")[![Reasno](https://avatars.githubusercontent.com/u/3881629?v=4)](https://github.com/Reasno "Reasno (5 commits)")[![leocavalcante](https://avatars.githubusercontent.com/u/183722?v=4)](https://github.com/leocavalcante "leocavalcante (5 commits)")[![deminy](https://avatars.githubusercontent.com/u/865547?v=4)](https://github.com/deminy "deminy (4 commits)")[![ha-ni-cc](https://avatars.githubusercontent.com/u/27479089?v=4)](https://github.com/ha-ni-cc "ha-ni-cc (3 commits)")[![xuanyanwow](https://avatars.githubusercontent.com/u/28777109?v=4)](https://github.com/xuanyanwow "xuanyanwow (2 commits)")[![go-sleep](https://avatars.githubusercontent.com/u/100214298?v=4)](https://github.com/go-sleep "go-sleep (2 commits)")[![huanghantao](https://avatars.githubusercontent.com/u/22836925?v=4)](https://github.com/huanghantao "huanghantao (2 commits)")[![wuwx](https://avatars.githubusercontent.com/u/4401?v=4)](https://github.com/wuwx "wuwx (2 commits)")[![xiaoguo0426](https://avatars.githubusercontent.com/u/8944962?v=4)](https://github.com/xiaoguo0426 "xiaoguo0426 (2 commits)")[![98P](https://avatars.githubusercontent.com/u/14154946?v=4)](https://github.com/98P "98P (2 commits)")[![leoqbc](https://avatars.githubusercontent.com/u/1481746?v=4)](https://github.com/leoqbc "leoqbc (1 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (1 commits)")[![lishuncoder](https://avatars.githubusercontent.com/u/35674916?v=4)](https://github.com/lishuncoder "lishuncoder (1 commits)")[![minbaby](https://avatars.githubusercontent.com/u/3191858?v=4)](https://github.com/minbaby "minbaby (1 commits)")

---

Tags

coroutinehyperfphpswoolephpmiddlewareframeworkswoolehyperfMicroservice

###  Code Quality

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/hyperf-hyperf-skeleton/health.svg)

```
[![Health](https://phpackages.com/badges/hyperf-hyperf-skeleton/health.svg)](https://phpackages.com/packages/hyperf-hyperf-skeleton)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
