Skip to content

Commit

Permalink
Merge pull request #18 from strangebuzz/docs/frankenphp
Browse files Browse the repository at this point in the history
docs: added installation notes for FrankenPHP
  • Loading branch information
COil authored Mar 7, 2024
2 parents ee91c5a + 76b73f5 commit 5a59bd9
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions README.md
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 \
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

0 comments on commit 5a59bd9

Please sign in to comment.