60 lines
2.5 KiB
Markdown
60 lines
2.5 KiB
Markdown
|
[](https://packagist.org/packages/flightphp/core)
|
||
|
|
[](https://packagist.org/packages/flightphp/core)
|
||
|
|
|
||
|
|
[](https://packagist.org/packages/flightphp/core)
|
||
|
|
[](https://packagist.org/packages/flightphp/core)
|
||
|
|
|
||
|
|
|
||
|
|
# What is Flight?
|
||
|
|
|
||
|
|
Flight is a fast, simple, extensible framework for PHP. Flight enables you to
|
||
|
|
quickly and easily build RESTful web applications.
|
||
|
|
|
||
|
|
# Basic Usage
|
||
|
|
|
||
|
|
```php
|
||
|
|
// if installed with composer
|
||
|
|
require 'vendor/autoload.php';
|
||
|
|
// or if installed manually by zip file
|
||
|
|
// require 'flight/Flight.php';
|
||
|
|
|
||
|
|
Flight::route('/', function () {
|
||
|
|
echo 'hello world!';
|
||
|
|
});
|
||
|
|
|
||
|
|
Flight::start();
|
||
|
|
```
|
||
|
|
|
||
|
|
## Skeleton App
|
||
|
|
|
||
|
|
You can also install a skeleton app. Go to [flightphp/skeleton](https://github.com/flightphp/skeleton) for instructions on how to get started!
|
||
|
|
|
||
|
|
# Documentation
|
||
|
|
|
||
|
|
We have our own documentation website that is built with Flight (naturally). Learn more about the framework at [docs.flightphp.com](https://docs.flightphp.com).
|
||
|
|
|
||
|
|
# Community
|
||
|
|
|
||
|
|
Chat with us on Matrix IRC [#flight-php-framework:matrix.org](https://matrix.to/#/#flight-php-framework:matrix.org)
|
||
|
|
|
||
|
|
# Upgrading From v2
|
||
|
|
|
||
|
|
If you have a current project on v2, you should be able to upgrade to v2 with no issues depending on how your project was built. If there are any issues with upgrade, they are documented in the [migrating to v3](https://docs.flightphp.com/learn/migrating-to-v3) documentation page. It is the intention of Flight to maintain longterm stability of the project and to not add rewrites with major version changes.
|
||
|
|
|
||
|
|
# Requirements
|
||
|
|
|
||
|
|
> [!IMPORTANT]
|
||
|
|
> Flight requires `PHP 7.4` or greater.
|
||
|
|
|
||
|
|
**Note:** PHP 7.4 is supported because at the current time of writing (2024) PHP 7.4 is the default version for some LTS Linux distributions. Forcing a move to PHP >8 would cause a lot of heartburn for those users.
|
||
|
|
|
||
|
|
The framework also supports PHP >8.
|
||
|
|
|
||
|
|
# Roadmap
|
||
|
|
|
||
|
|
To see the current and future roadmap for the Flight Framework, visit the [project roadmap](https://github.com/orgs/flightphp/projects/1/views/1)
|
||
|
|
|
||
|
|
# License
|
||
|
|
|
||
|
|
Flight is released under the [MIT](http://docs.flightphp.com/license) license.
|