feat(plugin): first version

Author: Maxime Leclercq

.github/workflows/recipe.yaml

@@ -9,15 +9,13 @@ jobs:
 
     recipe:
 
-        name: Flex recipe (PHP ${{ matrix.php }}, Sylius ${{ matrix.sylius }})
-
         runs-on: ubuntu-latest
 
         strategy:
             fail-fast: false
             matrix:
-                php: ['8.2']
-                sylius: ["~1.13.0"]
+                php: ['8.1', '8.2']
+                sylius: ["~1.12.0", "~1.13.0"]
 
         steps:
             - name: Setup PHP

.github/workflows/security.yaml

@@ -8,14 +8,12 @@ jobs:
 
     security:
 
-        name: Security check (PHP ${{ matrix.php }})
-
         runs-on: ubuntu-latest
 
         strategy:
             fail-fast: false
             matrix:
-                php: ['8.2']
+                php: ['8.1', '8.2']
 
         steps:
             - uses: actions/checkout@v3

.github/workflows/tests.yaml

@@ -9,14 +9,12 @@ jobs:
 
     php:
 
-        name: Quality tests (PHP ${{ matrix.php }})
-
         runs-on: ubuntu-latest
 
         strategy:
             fail-fast: false
             matrix:
-                php: ['8.2']
+                php: ['8.1', '8.2']
 
         env:
             COMPOSER_ARGS: --prefer-dist

.php-cs-fixer.dist.php

@@ -10,7 +10,7 @@
 declare(strict_types=1);
 
 $header = <<<'HEADER'
-This file is part of Monsieur Biz's  for Sylius.
+This file is part of Monsieur Biz's Blog plugin for Sylius.
 (c) Monsieur Biz <[email protected]>
 For the full copyright and license information, please view the LICENSE
 file that was distributed with this source code.

README.md

@@ -1,12 +1,67 @@
-# Sylius Blog Plugin
+<h1 align="center">Sylius Blog Plugin</h1>
 
+This plugin adds a blog to your Sylius project. It allows you to create blog articles, tags and authors.
 
+## Compatibility
+
+## Compatibility
+
+| Sylius Version | PHP Version |
+|---|---|
+| 1.12 | 8.1 - 8.2 |
+| 1.13 | 8.1 - 8.2 |
 
 ## Installation
 
-TBD
+If you want to use our recipes, you can add recipes endpoints to your composer.json by running this command:
+
+```bash
+composer config --no-plugins --json extra.symfony.endpoint '["https://api.github.com/repos/monsieurbiz/symfony-recipes/contents/index.json?ref=flex/master","flex://defaults"]'
+```
+
+Install the plugin via composer:
+
+```bash
+composer require monsieurbiz/sylius-blog-plugin:dev-master
+```
+
+<!-- The section on the flex recipe will be displayed when the flex recipe will be available on contrib repo
+<details><summary>For the installation without flex, follow these additional steps</summary>
+-->
+
+Change your `config/bundles.php` file to add this line for the plugin declaration:
+
+```php
+<?php
+
+return [
+    //..
+    MonsieurBiz\SyliusBlogPlugin\MonsieurBizSyliusBlogPlugin::class => ['all' => true],
+];
+```
+
+Add the plugin's routing by creating a new file in `config/routes/monsieurbiz_sylius_blog_plugin.yaml` with the following content:
+
+```yaml
+imports:
+    resource: '@MonsieurBizSyliusBlogPlugin/Resources/config/config.yaml'
+```
+
+Add the plugin's routing by creating a new file in `config/routes/monsieurbiz_sylius_blog_plugin.yaml` with the following content:
+
+```yaml
+monsieurbiz_blog_plugin:
+   resource: '@MonsieurBizSyliusBlogPlugin/Resources/config/routes.yaml'
+```
+
+And finally, update your database:
+
+```bash
+bin/console doctrine:migrations:migrate
+```
+
 
 ## License
 
 This plugin is under the MIT license.
-Please see the [LICENSE](LICENSE) file for more information.
+Please see the [LICENSE](LICENSE) file for more information._

composer.json

@@ -5,8 +5,10 @@
     "description": "",
     "license": "MIT",
     "require": {
-        "php": "^8.2",
-        "sylius/sylius": "^1.12.0 || ^1.13.0"
+        "php": "^8.1",
+        "sylius/sylius": "^1.12.0 || ^1.13.0",
+        "monsieurbiz/sylius-rich-editor-plugin": "^2.8",
+        "monsieurbiz/sylius-media-manager-plugin": "^1.1"
     },
     "require-dev": {
         "behat/behat": "^3.6.1",

dist/.env.local

@@ -0,0 +1,2 @@
+SYLIUS_FIXTURES_HOSTNAME=${SYMFONY_DEFAULT_ROUTE_HOST:-localhost}
+SYMFONY_IDE=phpstorm

dist/config/routes/monsieurbiz_sylius_blog_plugin.yaml

@@ -1,2 +1,2 @@
-imports:
+monsieurbiz_blog_plugin:
    resource: '@MonsieurBizSyliusBlogPlugin/Resources/config/routes.yaml'

docker-compose.yaml.dist

@@ -1,4 +1,3 @@
-version: '3.8'
 services:
     database:
         image: mysql:8.0
@@ -18,4 +17,4 @@ services:
             - 1080
 
 volumes:
-    database: {}
+    database: {}