Merge pull request #1 from BitBagCommerce/feature/UC-2-plugin-preparation

Configure plugin

Author: DominikWolos

.github/workflows/build.yml

@@ -1,9 +1,6 @@
 name: Build
 
 on:
-    push:
-        branches-ignore:
-            - 'dependabot/**'
     pull_request: ~
     release:
         types: [created]
@@ -170,16 +167,3 @@ jobs:
             -
                 name: Run PHPUnit
                 run: vendor/bin/phpunit --colors=always
-
-            -
-                name: Run Behat
-                run: vendor/bin/behat --colors --strict -vvv --no-interaction -f progress  || vendor/bin/behat --colors --strict -vvv --no-interaction -f progress --rerun
-
-            -
-                name: Upload Behat logs
-                uses: actions/upload-artifact@v3
-                if: failure()
-                with:
-                    name: Behat logs
-                    path: etc/build/
-                    if-no-files-found: ignore

README.md

@@ -1,122 +1,125 @@
-<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
-
-### Traditional
-
-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 set up a plugin's database, remember to configure you database credentials in `tests/Application/.env` and `tests/Application/.env.test`.
-
-### Docker
-
-1. Execute `docker compose up -d`
-
-2. Initialize plugin `docker compose exec app make init`
-
-3. See your browser `open localhost`
-
-## 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
-    ```
-
-### 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)
-    ```
+
+# BitBag SyliusUserComPlugin
+
+----
+
+We want to impact many unique eCommerce projects and build our brand recognition worldwide, so we are heavily involved in creating open-source solutions, especially for Sylius. We have already created over **35 extensions, which have been downloaded almost 2 million times.**
+
+You can find more information about our eCommerce services and technologies on our website: https://bitbag.io/. We have also created a unique service dedicated to creating plugins: https://bitbag.io/services/sylius-plugin-development.
+
+Do you like our work? Would you like to join us? Check out the **“Career” tab:** https://bitbag.io/pl/kariera.
+
+# About Us
+
+---
+
+BitBag is a software house that implements tailor-made eCommerce platforms with the entire infrastructure—from creating eCommerce platforms to implementing PIM and CMS systems to developing custom eCommerce applications, specialist B2B solutions, and migrations from other platforms.
+
+We actively participate in Sylius's development. We have already completed **over 150 projects**, cooperating with clients worldwide, including smaller enterprises and large international companies. We have completed projects for such important brands as **Mytheresa, Foodspring, Planeta Huerto (Carrefour Group), Albeco, Mollie, and ArtNight.**
+
+We have a 70-person team of experts: business analysts and consultants, eCommerce developers, project managers, and QA testers.
+
+**Our services:**
+* B2B and B2C eCommerce platform implementations
+* Multi-vendor marketplace platform implementations
+* eCommerce migrations
+* Sylius plugin development
+* Sylius consulting
+* Project maintenance and long-term support
+* PIM and CMS implementations
+
+**Some numbers from BitBag regarding Sylius:**
+* 70 experts on board
+* +150 projects delivered on top of Sylius
+* 30 countries of BitBag’s customers
+* 7 years in the Sylius ecosystem
+* +35 plugins created for Sylius
+
+---
+[![](https://bitbag.io/wp-content/uploads/2024/09/badges-sylius.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbandle)
+
+---
+
+
+
+## Table of Content
+
+***
+
+* [Overview](#overview)
+* [Installation](#installation)
+* [Testing](#testing)
+* [Functionalities](#functionalities)
+* [Demo](#demo)
+* [License](#license)
+* [Contact](#contact)
+* [Community](#community)
+
+# Overview
+
+----
+The **SyliusUserComPlugin** allows you to integrate your Sylius store with the User.com platform. User.com is a platform that allows you to automate your marketing, sales, and support processes. With this plugin, you can synchronize your Sylius store with User.com and use the data collected in your store to create personalized marketing campaigns, automate sales processes, and provide better customer support.
+
+
+# Installation
+----
+
+
+# Testing
+----
+
+```bash
+$ composer install
+$ cd tests/Application
+$ yarn install
+$ yarn build
+$ bin/console assets:install public -e test
+$ bin/console doctrine:schema:create -e test
+$ bin/console server:run 127.0.0.1:8080 -d public -e test
+$ open http://localhost:8080
+$ vendor/bin/behat
+```
+
+# Functionalities
+
+All main functionalities of the plugin are described **[here.](https://github.com/BitBagCommerce/SyliusUserComPlugin/blob/master/doc/functionalities.md)**
+
+---
+
+If you need some help with Sylius development, don't be hesitated to contact us directly. You can fill the form on [this site](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbundle) or send us an e-mail at hello@bitbag.io!
+
+---
+# Demo
+---
+We created a demo app with some useful use-cases of plugins! Visit http://demo.sylius.com/ to take a look at it.
+
+**If you need an overview of Sylius' capabilities, schedule a consultation with our expert.**
+
+[![](https://bitbag.io/wp-content/uploads/2020/10/button_free_consulatation-1.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbundle)
+
+
+# Additional resources for developers
+---
+To learn more about our contribution workflow and more, we encourage you to use the following resources:
+* [Sylius Documentation](https://docs.sylius.com/en/latest/)
+* [Sylius Contribution Guide](https://docs.sylius.com/en/latest/contributing/)
+* [Sylius Online Course](https://sylius.com/online-course/)
+* [Sylius Product Bundle Plugin Blog](https://bitbag.io/blog/product-bundling-sylius)
+
+# License
+---
+
+This plugin's source code is completely free and released under the terms of the MIT license.
+
+[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)
+
+# Contact
+---
+This open-source plugin was developed to help the Sylius community. If you have any additional questions, would like help with installing or configuring the plugin, or need any assistance with your Sylius project - let us know! **Contact us** or send us an **e-mail to hello@bitbag.io** with your question(s).
+
+# Community
+---- 
+
+For online communication, we invite you to chat with us & other users on **[Sylius Slack](https://sylius-devs.slack.com/).**
+
+[![](https://bitbag.io/wp-content/uploads/2024/09/badges-partners.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbundle)

behat.yml.dist

@@ -51,7 +51,7 @@ default:
         FriendsOfBehat\SymfonyExtension:
             bootstrap: tests/Application/config/bootstrap.php
             kernel:
-                class: Tests\Acme\SyliusExamplePlugin\Application\Kernel
+                class: Tests\BitBag\SyliusUserComPlugin\Application\Kernel
 
         FriendsOfBehat\VariadicExtension: ~
 

composer.json

@@ -1,10 +1,9 @@
 {
+    "name": "bitbag/user-com-plugin",
     "type": "sylius-plugin",
-    "keywords": [
-        "sylius",
-        "sylius-plugin"
-    ],
-    "license": "proprietary",
+    "keywords": ["sylius", "sylius-plugin"],
+    "description": "Integration with User.com for Sylius.",
+    "license": "MIT",
     "require": {
         "php": "^8.1",
         "sylius/sylius": "~1.13.0",
@@ -60,8 +59,8 @@
     },
     "autoload": {
         "psr-4": {
-            "Acme\\SyliusExamplePlugin\\": "src/",
-            "Tests\\Acme\\SyliusExamplePlugin\\": "tests/"
+            "BitBag\\SyliusUserComPlugin\\": "src/",
+            "Tests\\BitBag\\SyliusUserComPlugin\\": "tests/"
         }
     },
     "autoload-dev": {

config/services.xml

@@ -2,7 +2,5 @@
 
 <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
     <services>
-        <service id="Acme\SyliusExamplePlugin\Controller\GreetingController" autowire="true" autoconfigure="true" public="true" />
-        <!-- Put your services here -->
     </services>
 </container>

config/shop_routing.yml

@@ -1,13 +1 @@
 # Delete these routes and define your own shop routes here
-
-acme_sylius_example_static_welcome:
-    path: /static-welcome/{name}
-    defaults:
-        _controller: Acme\SyliusExamplePlugin\Controller\GreetingController::staticallyGreetAction
-        name: ~
-
-acme_sylius_example_dynamic_welcome:
-    path: /dynamic-welcome/{name}
-    defaults:
-        _controller: Acme\SyliusExamplePlugin\Controller\GreetingController::dynamicallyGreetAction
-        name: ~