Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added installation notes for FrankenPHP #18

Merged
merged 1 commit into from
Mar 7, 2024
Merged

docs: added installation notes for FrankenPHP #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,20 @@ Because a live demo is always better than all explanations. Here is it:
* Live demo at [https://microsymfony.ovh](https://microsymfony.ovh)


## Quick-start 🐰
## Quick-start with the Symfony binary 🎶

Run
You must have the [Symfony binary](https://symfony.com/download#step-1-install-symfony-cli) installed locally.

To create a new project from the GitHub template, run:

composer create-project strangebuzz/microsymfony
cd microsymfony

then
Then start the PHP server with make:

make start

or
Or with Castor:

castor symfony:start

Expand All @@ -44,6 +46,32 @@ Open [https://127.0.0.1:8000](https://127.0.0.1:8000) (considering your 8000 por
Enjoy! 🙂


### FrankenPHP 🧟‍

We can also use [FrankenPHP](https://frankenphp.dev/) to run MicroSymfony:
Create a new project from the GitHub template, run:

composer create-project strangebuzz/microsymfony
cd microsymfony

Install the [FrankenPHP Symfony runtime](https://github.com/php-runtime/frankenphp-symfony):

composer require runtime/frankenphp-symfony

Then run:

docker run \
-e FRANKENPHP_CONFIG="worker ./public/index.php" \
-e APP_RUNTIME=Runtime\\FrankenPhpSymfony\\Runtime \
-v $PWD:/app \
-p 80:80 -p 443:443 \
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
-p 80:80 -p 443:443 \
-p 80:80 -p 443:443 -p 443:443/udp \

For HTTP/3 support.

dunglas/frankenphp

Open [https://localhost](https://localhost)

Enjoy! 🙂


## Requirements ⚙

* [PHP 8.2](https://www.php.net/releases/8.2/en.php) (also works with [PHP 8.3](https://github.com/strangebuzz/MicroSymfony/actions/workflows/symfony.yml))
Expand Down
Loading