PHPackages                             sylius/plugin-skeleton - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. sylius/plugin-skeleton

ActiveSylius-plugin[Utility &amp; Helpers](/categories/utility)

sylius/plugin-skeleton
======================

Acme example plugin for Sylius.

v2.2.0(4mo ago)859.0k67[17 issues](https://github.com/Sylius/PluginSkeleton/issues)[2 PRs](https://github.com/Sylius/PluginSkeleton/pulls)MITPHPPHP ^8.2CI passing

Since Apr 30Pushed 4mo ago18 watchersCompare

[ Source](https://github.com/Sylius/PluginSkeleton)[ Packagist](https://packagist.org/packages/sylius/plugin-skeleton)[ GitHub Sponsors](https://github.com/sylius)[ RSS](/packages/sylius-plugin-skeleton/feed)WikiDiscussions 2.2 Synced yesterday

READMEChangelog (10)Dependencies (30)Versions (132)Used By (0)

 [    ![Sylius Logo.](https://camo.githubusercontent.com/ea9dddc934264aa7ec01cf3202c500f3d8b04448bce2571bdc74230efddda88f/68747470733a2f2f6d656469612e73796c6975732e636f6d2f73796c6975732d6c6f676f2d3830302e706e67)  ](https://sylius.com)

Plugin Skeleton
===============

[](#plugin-skeleton)

Skeleton for starting Sylius plugins.

Documentation
-------------

[](#documentation)

For a comprehensive guide on Sylius Plugins development please go to Sylius documentation, there you will find the [Plugin Development Guide](https://docs.sylius.com/plugins-development-guide/how-to-create-a-plugin-for-sylius) - it's a great place to start.

For more information about the **Test Application** included in the skeleton, please refer to the [Sylius documentation](https://docs.sylius.com/plugins-development-guide/test-application).

Quickstart Installation
-----------------------

[](#quickstart-installation)

Run `composer create-project sylius/plugin-skeleton ProjectName`.

### Traditional

[](#traditional)

1. From the plugin skeleton root directory, run the following commands:

    ```
    (cd vendor/sylius/test-application && yarn install)
    (cd vendor/sylius/test-application && yarn build)
    vendor/bin/console assets:install

    vendor/bin/console doctrine:database:create
    vendor/bin/console doctrine:migrations:migrate -n
    # Optionally load data fixtures
    vendor/bin/console sylius:fixtures:load -n
    ```

To be able to set up a plugin's database, remember to configure your database credentials in `tests/TestApplication/.env` and `tests/TestApplication/.env.test`.

2. Run your local server:

    ```
    symfony server:ca:install
    symfony server:start -d
    ```
3. Open your browser and navigate to `https://localhost:8000`.

### Docker

[](#docker)

1. Execute `make init` to initialize the container and install the dependencies.
2. Execute `make database-init` to create the database and run migrations.
3. (Optional) Execute `make load-fixtures` to load the fixtures.
4. Your app is available at `http://localhost`.

Usage
-----

[](#usage)

### Running plugin tests

[](#running-plugin-tests)

- PHPUnit

    ```
    vendor/bin/phpunit
    ```
- Behat (non-JS scenarios)

    ```
    vendor/bin/behat --strict --tags="~@javascript&&~@mink:chromedriver"
    ```
- Behat (JS scenarios)

    1. [Install Symfony CLI command](https://symfony.com/download).
    2. Start Headless Chrome:

    ```
    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`:

    ```
    symfony server:ca:install
    APP_ENV=test symfony server:start --port=8080 --daemon
    ```

    4. Run Behat:

    ```
    vendor/bin/behat --strict --tags="@javascript,@mink:chromedriver"
    ```
- Static Analysis

    - PHPStan

        ```
        vendor/bin/phpstan analyse -c phpstan.neon -l max src/
        ```
- Coding Standard

    ```
    vendor/bin/ecs check
    ```

### Opening Sylius with your plugin

[](#opening-sylius-with-your-plugin)

- Using `test` environment:

    ```
    APP_ENV=test vendor/bin/console sylius:fixtures:load -n
    APP_ENV=test symfony server:start -d
    ```
- Using `dev` environment:

    ```
    vendor/bin/console sylius:fixtures:load -n
    symfony server:start -d
    ```

###  Health Score

62

—

FairBetter than 99% of packages

Maintenance70

Regular maintenance activity

Popularity40

Moderate usage in the ecosystem

Community32

Small or concentrated contributor base

Maturity93

Battle-tested with a long release history

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~25 days

Recently: every ~47 days

Total

127

Last Release

148d ago

Major Versions

v0.1.0 → v1.0.02017-09-19

1.12.x-dev → v2.0.02024-12-10

1.14.x-dev → v2.0.12025-01-28

PHP version history (8 changes)v0.1.0PHP ^5.6|^7.0

v1.0.0PHP ^7.1

v1.3.0-BETAPHP ^7.2

v1.7.0PHP ^7.3

v1.10.0-ALPHA.1PHP ^7.4 || ^8.0

v1.11.0PHP ^8.0

1.13.x-devPHP ^8.1

v2.0.0PHP ^8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/719423?v=4)[Sylius eCommerce](/maintainers/sylius)[@Sylius](https://github.com/Sylius)

![](https://www.gravatar.com/avatar/4b4a5a1a9293502aa8573551fab020963a9050c5cca4524433b6d94214d3b480?d=identicon)[GSadee](/maintainers/GSadee)

---

Top Contributors

[![pamil](https://avatars.githubusercontent.com/u/1897953?v=4)](https://github.com/pamil "pamil (323 commits)")[![GSadee](https://avatars.githubusercontent.com/u/6140884?v=4)](https://github.com/GSadee "GSadee (76 commits)")[![Zales0123](https://avatars.githubusercontent.com/u/6212718?v=4)](https://github.com/Zales0123 "Zales0123 (54 commits)")[![lchrusciel](https://avatars.githubusercontent.com/u/6213903?v=4)](https://github.com/lchrusciel "lchrusciel (41 commits)")[![Rafikooo](https://avatars.githubusercontent.com/u/40125720?v=4)](https://github.com/Rafikooo "Rafikooo (32 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (27 commits)")[![NoResponseMate](https://avatars.githubusercontent.com/u/9448101?v=4)](https://github.com/NoResponseMate "NoResponseMate (23 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (23 commits)")[![bitbager](https://avatars.githubusercontent.com/u/28542010?v=4)](https://github.com/bitbager "bitbager (12 commits)")[![stefandoorn](https://avatars.githubusercontent.com/u/4903082?v=4)](https://github.com/stefandoorn "stefandoorn (9 commits)")[![pjedrzejewski](https://avatars.githubusercontent.com/u/614970?v=4)](https://github.com/pjedrzejewski "pjedrzejewski (9 commits)")[![loevgaard](https://avatars.githubusercontent.com/u/2412177?v=4)](https://github.com/loevgaard "loevgaard (8 commits)")[![coldic3](https://avatars.githubusercontent.com/u/13316080?v=4)](https://github.com/coldic3 "coldic3 (7 commits)")[![TheMilek](https://avatars.githubusercontent.com/u/53942444?v=4)](https://github.com/TheMilek "TheMilek (6 commits)")[![bartoszpietrzak1994](https://avatars.githubusercontent.com/u/22262296?v=4)](https://github.com/bartoszpietrzak1994 "bartoszpietrzak1994 (6 commits)")[![mpysiak](https://avatars.githubusercontent.com/u/39049059?v=4)](https://github.com/mpysiak "mpysiak (6 commits)")[![Cholin2000](https://avatars.githubusercontent.com/u/85901846?v=4)](https://github.com/Cholin2000 "Cholin2000 (4 commits)")[![nedac-sorbo](https://avatars.githubusercontent.com/u/46560227?v=4)](https://github.com/nedac-sorbo "nedac-sorbo (4 commits)")[![vvasiloi](https://avatars.githubusercontent.com/u/7114562?v=4)](https://github.com/vvasiloi "vvasiloi (4 commits)")[![camilleislasse](https://avatars.githubusercontent.com/u/34024380?v=4)](https://github.com/camilleislasse "camilleislasse (3 commits)")

---

Tags

hacktoberfestsyliussylius-pluginsyliussylius-plugintest-appication

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/sylius-plugin-skeleton/health.svg)

```
[![Health](https://phpackages.com/badges/sylius-plugin-skeleton/health.svg)](https://phpackages.com/packages/sylius-plugin-skeleton)
```

###  Alternatives

[sylius/refund-plugin

Plugin provides basic refunds functionality for Sylius application.

701.8M20](/packages/sylius-refund-plugin)[webgriffe/sylius-table-rate-shipping-plugin

Provides table rate shipping calculator.

1493.8k](/packages/webgriffe-sylius-table-rate-shipping-plugin)[stefandoorn/sitemap-plugin

Sitemap Plugin for Sylius

841.1M1](/packages/stefandoorn-sitemap-plugin)[monsieurbiz/sylius-rich-editor-plugin

A Rich Editor plugin for Sylius.

75416.2k6](/packages/monsieurbiz-sylius-rich-editor-plugin)[odiseoteam/sylius-vendor-plugin

Vendor plugin for Sylius. Add Vendor (Brand) to your products

6068.4k1](/packages/odiseoteam-sylius-vendor-plugin)[monsieurbiz/sylius-menu-plugin

This plugins allows you to manage menus.

1580.0k1](/packages/monsieurbiz-sylius-menu-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
