Skip to content

Commit

Permalink
feat: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Etienne Gutbub committed Jun 26, 2023
1 parent 854de13 commit ceedabc
Show file tree
Hide file tree
Showing 8 changed files with 86 additions and 6 deletions.
20 changes: 20 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -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.
68 changes: 66 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,66 @@
# SyliusContactRequestPlugin
A contact request plugin for Sylius
<p align="center">
<a href="https://monsieurbiz.com" target="_blank">
<img src="https://monsieurbiz.com/logo.png" width="250px" alt="Monsieur Biz logo" />
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://monsieurbiz.com/agence-web-experte-sylius" target="_blank">
<img src="https://demo.sylius.com/assets/shop/img/logo.png" width="200px" alt="Sylius logo" />
</a>
<br/>
<img src="https://monsieurbiz.com/assets/images/sylius_badge_extension-artisan.png" width="100" alt="Monsieur Biz is a Sylius Extension Artisan partner">
</p>

<h1 align="center">Contact Request for Sylius</h1>

[![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
<?php

return [
//..
MonsieurBiz\SyliusContactRequestPlugin\MonsieurBizSyliusContactRequestPlugin::class => ['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).
1 change: 0 additions & 1 deletion TESTING.md

This file was deleted.

This file was deleted.

Binary file added docs/images/demo1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/demo2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion src/Resources/config/config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
imports:
- { resource: 'resources.yaml' }
- { resource: 'grids/*' }

0 comments on commit ceedabc

Please sign in to comment.