Skip to content

Commit f91501c

Browse files
authored
2.x update docs (#11)
* Added version table and improve clarity in README Added a table to outline repository versions and compatibility. Revised the "Getting Started" section for better readability, simplifying explanations and clarifying steps for setup and production deployment. * Fixed HTTP/3 default port in compose.yaml Corrected the default value for the HTTP/3 port from 433 to 443 in compose.yaml. Ensures accurate configuration and prevents potential connectivity issues. * Updated dependencies to use broader version constraints Relaxed version constraints in `composer.json` for several packages to allow for greater compatibility. Updated corresponding `composer.lock` to reflect these changes. No functionality changes expected.
1 parent 2de8972 commit f91501c

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,28 @@ A [Docker](https://docker.com)-based installer and runtime for the [Sylius](http
1212

1313
![CI](https://github.com/royalphp/frankenphp-sylius/workflows/CI/badge.svg)
1414

15+
## Versions
16+
17+
| Repository Branch | Repository Tag | Sylius Version | Symfony Compatibility | PHP Compatibility |
18+
|-------------------|----------------|----------------|-----------------------|-------------------|
19+
| `2.x` | `0.2.*` | `^2.0` | `^7.2` | `^8.3` |
20+
| `1.x` | `0.1.*` | `^1.14` | `^6.4` | `^8.3` |
21+
1522
## Getting Started
1623

17-
All control is via `Makefile`, to see all available commands, run `make`.
18-
For a quick start, execute the following command:
24+
All control is via `Makefile`, to see all available commands, run `make`. For a quick start, execute the following command:
1925

2026
```shell
2127
make setup
2228
```
2329

24-
Under the hood, this command executes several other commands,
25-
creates the necessary images, fills the database with samples data, and build assets for the client side,
26-
all this is necessary for the first launch of the project, and in the future you will only `make up` or `make down` your project.
30+
Under the hood, this command executes a few other commands needed to run your project for the first time,
31+
and you won't need this command again (unless you want to reconfigure your project).
2732
After successful execution of this command, you can open it in the browser at the standard url: https://localhost/
2833

29-
By default, you're working in a development environment, so for most commands, the `PROJECT_MODE=dev` option is also executed.
30-
However, if you want to deploy your project to a production server, you need to explicitly specify this when executing commands
31-
(as well as specify the necessary environment variables for your sensitive data),
32-
for example, to quickly deploy in a production environment, execute the following command:
33-
34-
```shell
35-
make setup PROJECT_MODE=prod
36-
```
34+
By default, you are working in a development environment, so `make` commands do not require additional options,
35+
however, if you want to deploy your project to a production server, or run any command in production,
36+
you explicitly need to specify the `PROJECT_MODE=prod` option, which defines the appropriate settings.
3737

3838
## Documentation
3939

compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ services:
2626
protocol: tcp
2727
# HTTP/3
2828
- target: 443
29-
published: ${HTTP3_PORT:-433}
29+
published: ${HTTP3_PORT:-443}
3030
protocol: udp
3131

3232
worker:

composer.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,22 @@
2626
"dragonmantank/cron-expression": "^3.4",
2727
"runtime/frankenphp-symfony": "^0.2.0",
2828
"sylius/paypal-plugin": "^2.0",
29-
"sylius/sylius": "^2.0.3",
29+
"sylius/sylius": "^2.0",
3030
"symfony/console": "7.2.*",
3131
"symfony/dotenv": "7.2.*",
32-
"symfony/flex": "^2.4.7",
32+
"symfony/flex": "^2",
3333
"symfony/framework-bundle": "7.2.*",
34-
"symfony/monolog-bundle": "^3.10",
34+
"symfony/monolog-bundle": "^3.0",
3535
"symfony/runtime": "7.2.*",
3636
"symfony/scheduler": "7.2.*",
3737
"symfony/yaml": "7.2.*"
3838
},
3939
"require-dev": {
40-
"phpunit/phpunit": "^12.0.2",
40+
"phpunit/phpunit": "^12.0",
4141
"symfony/browser-kit": "7.2.*",
4242
"symfony/css-selector": "7.2.*",
4343
"symfony/debug-bundle": "7.2.*",
44-
"symfony/maker-bundle": "^1.62.1",
44+
"symfony/maker-bundle": "^1.62",
4545
"symfony/phpunit-bridge": "^7.2",
4646
"symfony/stopwatch": "7.2.*",
4747
"symfony/web-profiler-bundle": "7.2.*"

composer.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)