mirror of
https://github.com/jbcr/SyliusGDPRPlugin.git
synced 2026-04-25 09:28:17 +02:00
Luca Gallois
113 lines
3.0 KiB
Markdown
113 lines
3.0 KiB
Markdown
<p align="center">
|
|
<a href="https://sylius.com" target="_blank">
|
|
<img src="https://demo.sylius.com/assets/shop/img/logo.png" />
|
|
</a>
|
|
</p>
|
|
|
|
<h1 align="center">Plugin Skeleton</h1>
|
|
|
|
<p align="center">Skeleton for starting Sylius plugins.</p>
|
|
|
|
## Documentation
|
|
|
|
For a comprehensive guide on Sylius Plugins development please go to Sylius documentation,
|
|
there you will find the <a href="https://docs.sylius.com/en/latest/plugin-development-guide/index.html">Plugin Development Guide</a>, that is full of examples.
|
|
|
|
## Quickstart Installation
|
|
|
|
1. Run `composer create-project sylius/plugin-skeleton ProjectName`.
|
|
|
|
2. From the plugin skeleton root directory, run the following commands:
|
|
|
|
```bash
|
|
$ (cd tests/Application && yarn install)
|
|
$ (cd tests/Application && yarn build)
|
|
$ (cd tests/Application && APP_ENV=test bin/console assets:install public)
|
|
|
|
$ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
|
|
$ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)
|
|
```
|
|
|
|
To be able to setup a plugin's database, remember to configure you database credentials in `tests/Application/.env` and `tests/Application/.env.test`.
|
|
|
|
## Usage
|
|
|
|
### Running plugin tests
|
|
|
|
- PHPUnit
|
|
|
|
```bash
|
|
vendor/bin/phpunit
|
|
```
|
|
|
|
- PHPSpec
|
|
|
|
```bash
|
|
vendor/bin/phpspec run
|
|
```
|
|
|
|
- Behat (non-JS scenarios)
|
|
|
|
```bash
|
|
vendor/bin/behat --strict --tags="~@javascript"
|
|
```
|
|
|
|
- Behat (JS scenarios)
|
|
|
|
1. [Install Symfony CLI command](https://symfony.com/download).
|
|
|
|
2. Start Headless Chrome:
|
|
|
|
```bash
|
|
google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1
|
|
```
|
|
|
|
3. Install SSL certificates (only once needed) and run test application's webserver on `127.0.0.1:8080`:
|
|
|
|
```bash
|
|
symfony server:ca:install
|
|
APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon
|
|
```
|
|
|
|
4. Run Behat:
|
|
|
|
```bash
|
|
vendor/bin/behat --strict --tags="@javascript"
|
|
```
|
|
|
|
- Static Analysis
|
|
|
|
- Psalm
|
|
|
|
```bash
|
|
vendor/bin/psalm
|
|
```
|
|
|
|
- PHPStan
|
|
|
|
```bash
|
|
vendor/bin/phpstan analyse -c phpstan.neon -l max src/
|
|
```
|
|
|
|
- Coding Standard
|
|
|
|
```bash
|
|
vendor/bin/ecs check src
|
|
```
|
|
|
|
### Opening Sylius with your plugin
|
|
|
|
- Using `test` environment:
|
|
|
|
```bash
|
|
(cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
|
|
(cd tests/Application && APP_ENV=test bin/console server:run -d public)
|
|
```
|
|
|
|
- Using `dev` environment:
|
|
|
|
```bash
|
|
(cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load)
|
|
(cd tests/Application && APP_ENV=dev bin/console server:run -d public)
|
|
```
|