Warning

This branch contains the ongoing, unreleased work for the Hypervel 0.4 rewrite.

Hypervel 0.4 is not ready for use yet. APIs, behavior, configuration, and package internals may change unexpectedly while the rewrite is still in progress.

The published documentation at hypervel.org/docs currently covers Hypervel 0.3. If you are experimenting with this branch, use the in-progress 0.4 documentation. If you are coming from Laravel, begin with the porting guide.

Please do not use this branch for projects until a beta release is tagged. If you are experimenting or testing the rewrite, bug reports and feedback are very welcome.

About Hypervel

Hypervel is a modern, opinionated PHP framework built for Swoole. It runs applications inside long-lived workers and uses coroutines to handle many requests, jobs, and connections concurrently.

When one coroutine is waiting on a database query, cache lookup, queue operation, file access, or HTTP request, the worker can continue serving other work. You write ordinary sequential PHP while Hypervel handles concurrent I/O underneath.

Hypervel is built for traditional web applications, APIs, microservices, real-time services, background workers, and applications that spend much of their time waiting on external systems.

About This Repository

This repository contains the application skeleton for the Hypervel framework. It provides the default application structure and configuration used when creating a new Hypervel project. The framework source and first-party packages are maintained in the Hypervel components repository.

Use this repository's Issues only for problems with the application skeleton's default files, configuration, or starter code. Report framework bugs through the components repository's Issues, and use its Discussions for support questions, feature requests, and ideas.

Getting Started

Create a new Hypervel application using Composer's create-project command:

composer create-project hypervel/hypervel example-app

cd example-app
php artisan serve

Once the development server has started, the application will be available at http://localhost:8000.

If you prefer to build your frontend with Inertia and React, you may start with the official React application starter kit:

composer create-project hypervel/react-starter-kit example-app

See the installation documentation and starter kit documentation for the complete setup instructions.

Framework Features

Hypervel includes the features expected from a modern full-stack framework:

• Fast, expressive routing and middleware.
• A powerful dependency injection container and service provider system.
• Multiple session and cache stores.
• Eloquent ORM, schema building, and database migrations.
• Background jobs, job batching, and task scheduling.
• Real-time event broadcasting and WebSocket support.
• Authentication, authorization, validation, notifications, mail, and filesystem storage.
• Blade templates and Vite integration.
• Built-in support for coroutines and concurrent HTTP requests.
• Persistent database and Redis connection pools.
• Coroutine-aware testing with a familiar assertion API.

Laravel Compatibility

Hypervel aims for Laravel API compatibility wherever it fits. However, Hypervel is not a Laravel clone or drop-in replacement. Many Hypervel components are ports of Laravel packages, adapted for Hypervel's asynchronous runtime, performance requirements, and coroutine safety, but the framework itself has its own architecture, features, supported integrations, and direction.

Moving an existing Laravel application or package to Hypervel is a deliberate port, not a namespace replacement. The porting guide explains what needs to change and why.

Learning Hypervel

The complete Hypervel documentation is available at hypervel.org/docs.

Hypervel's documentation follows the structure and style of Laravel's documentation, and portions are adapted from it. Our thanks to the Laravel community.

AI-Assisted Development

Hypervel Boost gives AI coding agents Hypervel-specific documentation, tools, and guidelines for the packages installed in your application. Install Boost as a development dependency, then run its installer:

composer require hypervel/boost --dev

php artisan boost:install

Boost can search version-specific documentation, inspect your application, query its database, read browser logs, generate tests, and execute code through Tinker. Its guidelines help coding agents follow Hypervel conventions.

Contributing

Thank you for considering contributing to Hypervel. The contribution guide explains which changes are accepted, how to run the required checks, and how to prepare a pull request.

Framework changes should be submitted to the components repository. Issues and pull requests in this repository should be limited to the default application structure, configuration, and starter code.

Code of Conduct

Please review and follow Hypervel's Code of Conduct when participating in the community.

Security Vulnerabilities

If you discover a security vulnerability in Hypervel, please report it privately by emailing Albert Chen at albert@hypervel.org. Security vulnerabilities will be addressed promptly.

Please do not report security vulnerabilities through public GitHub issues or discussions.

License

The Hypervel framework is open-sourced software licensed under the MIT license.

Created by

Albert Chen

Raj Siva-Rajah