Skip to content

Commit

Permalink
Update doc/01-installation.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
senghe committed Dec 18, 2023
1 parent 0f8cd3b commit df61515
Showing 1 changed file with 69 additions and 67 deletions.
136 changes: 69 additions & 67 deletions doc/01-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,103 +5,105 @@

## Installation

*We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.*

1. *We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.*
1. Please install the plugin with composer:

```bash
$ composer require bitbag/wishlist-plugin --no-scripts
```
```bash
$ composer require bitbag/wishlist-plugin --no-scripts
```

2. Add plugin dependencies to your `config/bundles.php` file:
```php
// config/bundles.php

return [
...

BitBag\SyliusWishlistPlugin\BitBagSyliusWishlistPlugin::class => ['all' => true],
];
```
```php
// config/bundles.php
return [
...
BitBag\SyliusWishlistPlugin\BitBagSyliusWishlistPlugin::class => ['all' => true],
];
```

3. Import required config in your `config/packages/_sylius.yaml` file:
```yaml
# config/packages/_sylius.yaml

imports:
...

- { resource: "@BitBagSyliusWishlistPlugin/Resources/config/config.yml" }
```
```yaml
# config/packages/_sylius.yaml
imports:
...
- { resource: "@BitBagSyliusWishlistPlugin/Resources/config/config.yml" }
```
4. Import routing in your `config/routes.yaml` file:
```yaml
# config/routes.yaml
bitbag_sylius_wishlist_plugin:
resource: "@BitBagSyliusWishlistPlugin/Resources/config/routing.yml"
```
```yaml
# config/routes.yaml
bitbag_sylius_wishlist_plugin:
resource: "@BitBagSyliusWishlistPlugin/Resources/config/routing.yml"
```
5. Clear application cache by using command:
```bash
$ bin/console cache:clear
```

6. Update your database
```bash
$ bin/console cache:clear
```
First, please run legacy-versioned migrations by using command:
6. Update your database:
```bash
$ bin/console doctrine:migrations:migrate
```
If you use migrations in your project, please run plugin migrations by using command:
```bash
$ bin/console doctrine:migrations:migrate
```
After migration, please create a new diff migration and run it:
If you don't use migrations in your project, please update your database by using command:
```bash
$ bin/console doctrine:schema:update --dump-sql # Please review queries before running them!
$ bin/console doctrine:schema:update --force # This executes the queries on your database.
```
```bash
$ bin/console doctrine:migrations:diff
$ bin/console doctrine:migrations:migrate
```
**Note:** If you are running it on production, add the `-e prod` flag to this command.
**Note:** If you are running it on production, add the `-e prod` flag to this command.
7. Please add plugin templates into your project:
```bash
$ cp -R vendor/bitbag/wishlist-plugin/tests/Application/templates/bundles/SyliusShopBundle/Product templates/bundles/SyliusShopBundle
$ cp vendor/bitbag/wishlist-plugin/tests/Application/templates/bundles/SyliusShopBundle/_header.html.twig templates/bundles/SyliusShopBundle
$ cp vendor/bitbag/wishlist-plugin/tests/Application/templates/bundles/SyliusShopBundle/_logo.html.twig templates/bundles/SyliusShopBundle
```
```bash
$ cp -R vendor/bitbag/wishlist-plugin/tests/Application/templates/bundles/SyliusShopBundle/Product templates/bundles/SyliusShopBundle
$ cp vendor/bitbag/wishlist-plugin/tests/Application/templates/bundles/SyliusShopBundle/_header.html.twig templates/bundles/SyliusShopBundle
$ cp vendor/bitbag/wishlist-plugin/tests/Application/templates/bundles/SyliusShopBundle/_logo.html.twig templates/bundles/SyliusShopBundle
```
8. Add plugin assets to your project
We recommend you to use Webpack (Encore), for which we have prepared four different instructions on how to add this plugin's assets to your project:
We recommend you to use Webpack (Encore), for which we have prepared four different instructions on how to add this plugin's assets to your project:
- [Import webpack config](./01.1-webpack-config.md)*
- [Add entry to existing config](./01.2-webpack-entry.md)
- [Import entries in your entry.js files](./01.3-import-entry.md)
- [Your own custom config](./01.4-custom-solution.md)
- [Import webpack config](./01.1-webpack-config.md)*
- [Add entry to existing config](./01.2-webpack-entry.md)
- [Import entries in your entry.js files](./01.3-import-entry.md)
- [Your own custom config](./01.4-custom-solution.md)
<small>* Default option for plugin development</small>
<small>* Default option for plugin development</small>
However, if you are not using Webpack, here are instructions on how to add optimized and compressed assets directly to your project templates:
However, if you are not using Webpack, here are instructions on how to add optimized and compressed assets directly to your project templates:
- [Non webpack solution](./01.5-non-webpack.md)
- [Non webpack solution](./01.5-non-webpack.md)
## Asynchronous Messenger case
In case you use asynchronous Messenger transport by default, there is a need to configure all Wishlist commands to sync transport.
You can do this by configuring the `WishlistSyncCommandInterface` interface to sync transport (as presented on code listing below).
In case you use asynchronous Messenger transport by default, there is a need to configure all Wishlist commands to sync transport.
You can do this by configuring the `WishlistSyncCommandInterface` interface to sync transport (as presented on code listing below).
```yaml
# config/packages/messenger.yaml
```yaml
# config/packages/messenger.yaml
framework:
messenger:
transports:
sync: 'sync://'
routing:
'BitBag\SyliusWishlistPlugin\Command\Wishlist\WishlistSyncCommandInterface': sync
```
framework:
messenger:
transports:
sync: 'sync://'
routing:
'BitBag\SyliusWishlistPlugin\Command\Wishlist\WishlistSyncCommandInterface': sync
```
All commands from the plugin implement the `WishlistSyncCommandInterface` interface, so there is no need for other configuration.
All commands from the plugin implement the `WishlistSyncCommandInterface` interface, so there is no need for other configuration.

0 comments on commit df61515

Please sign in to comment.