diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..4f8ae79 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,20 @@ +## Node + +Be sure you have node 16 on your machine. You can use NVM to easily switch versions. + +## Docker + +Be sure you have docker on your machine. + +## Symfony + +Be sure you have the Symfony binary on your machine. + +```shell + curl -sS https://get.symfony.com/cli/installer | bash + ``` + +## Run test application + +You just have to run `make install` on the root of the project and go to http://127.0.0.1:8080 when installation is +done. diff --git a/README.md b/README.md index 0fba00f..f231d02 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ -# SyliusContactRequestPlugin -A contact request plugin for Sylius \ No newline at end of file +

+ + Monsieur Biz logo + +      + + Sylius logo + +
+ Monsieur Biz is a Sylius Extension Artisan partner +

+ +

Contact Request for Sylius

+ +[![Contact Request Plugin license](https://img.shields.io/github/license/monsieurbiz/SyliusContactRequestPlugin?public)](https://github.com/monsieurbiz/SyliusContactRequestPlugin/blob/master/LICENSE) +[![Tests Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusContactRequestPlugin/tests.yml?branch=master&logo=github)](https://github.com/monsieurbiz/SyliusContactRequestPlugin/actions?query=workflow%3ATests) +[![Security Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusContactRequestPlugin/security.yml?branch=master&label=security&logo=github)](https://github.com/monsieurbiz/SyliusContactRequestPlugin/actions?query=workflow%3ASecurity) + +This plugin saves contact requests made on the native form into the database allowing us to see them in the back-office of Sylius. + +![Demo of the Contact Request](docs/images/demo1.png) +![Demo of the Contact Request](docs/images/demo2.png) + +## Installation + +Install the plugin via composer: + +```bash +composer require monsieurbiz/sylius-contact-request-plugin +``` + +## Getting started + +Submit a contact request from the native contact form. Them go in the back-office in the customer menu node you will have a new menu 'contact requests', click on it and +you can see a grid with the contact requests created. +Obviously, this plugin is not retroactive and contact requests made before the plugin was installed will not be displayed. + +### For the installation without flex, follow these additional steps + +Change your `config/bundles.php` file to add this line for the plugin declaration: + +```php + ['all' => true], +]; +``` + +Copy the plugin configuration files in your `config` folder: + +```bash +cp -Rv vendor/monsieurbiz/sylius-contact-request-plugin/recipes/1.0/config/ config +``` + +## Contributing + +You can find a way to run the plugin without effort in the file [DEVELOPMENT.md](./DEVELOPMENT.md). + +Then you can open an issue or a Pull Request if you want! 😘 +Thank you! + +## License + +This plugin is completely free and released under the [MIT License](https://github.com/monsieurbiz/SyliusContactRequestPlugin/blob/master/LICENSE). diff --git a/TESTING.md b/TESTING.md deleted file mode 100644 index f00b526..0000000 --- a/TESTING.md +++ /dev/null @@ -1 +0,0 @@ -# Testing diff --git a/dist/config/packages/monsieurbiz_sylius_contact_request_plugin.yaml b/dist/config/packages/monsieurbiz_sylius_contact_request_plugin.yaml deleted file mode 100644 index 06f6e05..0000000 --- a/dist/config/packages/monsieurbiz_sylius_contact_request_plugin.yaml +++ /dev/null @@ -1,2 +0,0 @@ -imports: - - { resource: "@MonsieurBizSyliusContactRequestPlugin/Resources/config/config.yaml" } diff --git a/docs/images/demo1.png b/docs/images/demo1.png new file mode 100644 index 0000000..596c0b6 Binary files /dev/null and b/docs/images/demo1.png differ diff --git a/docs/images/demo2.png b/docs/images/demo2.png new file mode 100644 index 0000000..66df0d9 Binary files /dev/null and b/docs/images/demo2.png differ diff --git a/dist/config/routes/monsieurbiz_sylius_contact_request_plugin.yaml b/recipes/1.0/config/routes/monsieurbiz_sylius_contact_request_plugin.yaml similarity index 100% rename from dist/config/routes/monsieurbiz_sylius_contact_request_plugin.yaml rename to recipes/1.0/config/routes/monsieurbiz_sylius_contact_request_plugin.yaml diff --git a/src/Resources/config/config.yaml b/src/Resources/config/config.yaml index 70c1280..75387a2 100644 --- a/src/Resources/config/config.yaml +++ b/src/Resources/config/config.yaml @@ -1,4 +1,3 @@ imports: - { resource: 'resources.yaml' } - { resource: 'grids/*' } -