https://github.com/webgriffe/webgriffesyliustablerateshippingplugin
Sylius plugin which allows to define shipping rates using weight/rate tables.
https://github.com/webgriffe/webgriffesyliustablerateshippingplugin
shipping-rates sylius
Last synced: 10 months ago
JSON representation
Sylius plugin which allows to define shipping rates using weight/rate tables.
- Host: GitHub
- URL: https://github.com/webgriffe/webgriffesyliustablerateshippingplugin
- Owner: webgriffe
- Created: 2018-09-14T08:10:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T14:56:07.000Z (over 1 year ago)
- Last Synced: 2025-09-03T11:24:59.072Z (10 months ago)
- Topics: shipping-rates, sylius
- Language: PHP
- Homepage:
- Size: 219 KB
- Stars: 13
- Watchers: 5
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table Rate Shipping Plugin
This plugin allows to define shipping rates using weight tables.
## Installation
1. Run `composer require --no-scripts webgriffe/sylius-table-rate-shipping-plugin`.
2. Add the plugin to the `config/bundles.php` file:
```php
Webgriffe\SyliusTableRateShippingPlugin\WebgriffeSyliusTableRateShippingPlugin::class => ['all' => true],
```
3. Add the plugin's config to by creating the file `config/packages/webgriffe_sylius_table_rate_shipping_plugin.yaml` with the following content:
```yaml
imports:
- { resource: "@WebgriffeSyliusTableRateShippingPlugin/Resources/config/config.yml" }
```
4. Add the plugin's routing by creating the file `config/routes/webgriffe_sylius_table_rate_shipping_plugin.yaml` with the following content:
```yaml
webgriffe_sylius_table_rate_shipping_plugin_shop:
resource: "@WebgriffeSyliusTableRateShippingPlugin/Resources/config/shop_routing.yml"
prefix: /{_locale}
requirements:
_locale: ^[A-Za-z]{2,4}(_([A-Za-z]{4}|[0-9]{3}))?(_([A-Za-z]{2}|[0-9]{3}))?$
webgriffe_sylius_table_rate_shipping_plugin_admin:
resource: "@WebgriffeSyliusTableRateShippingPlugin/Resources/config/admin_routing.yml"
prefix: /%sylius_admin.path_name%
```
5. Finish the installation by updating the database schema and installing assets:
```bash
bin/console cache:clear
bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate
bin/console assets:install
bin/console sylius:theme:assets:install
```
## Contributing
To contribute you need to:
1. Clone this repository into you development environment and go to the plugin's root directory,
2. Then, from the plugin's root directory, run the following commands:
```bash
composer install
```
3. Copy `tests/Application/.env` in `tests/Application/.env.local` and set configuration specific for your development environment.
4. Then, from the plugin's root directory, run the following commands:
```bash
(cd tests/Application && yarn install)
(cd tests/Application && yarn build)
(cd tests/Application && bin/console assets:install public)
(cd tests/Application && bin/console doctrine:database:create)
(cd tests/Application && bin/console doctrine:schema:create)
(cd tests/Application && bin/console sylius:fixtures:load)
(cd tests/Application && symfony server:start -d) # Requires Symfony CLI (https://symfony.com/download)
```
5. Now at http://localhost:8080/ you have a full Sylius testing application which runs the plugin
### Testing
After your changes you must ensure that the tests are still passing.
First setup your test database:
```bash
(cd tests/Application && bin/console -e test doctrine:database:create)
(cd tests/Application && bin/console -e test doctrine:schema:create)
```
This plugin's test application already comes with a test configuration that uses SQLite as test database.
If you don't want this you can create a `tests/Application/.env.test.local` with a different `DATABASE_URL`.
The current CI suite runs the following tests:
* Easy Coding Standard
```bash
vendor/bin/ecs check src/ tests/Behat/
```
* PHPStan
```bash
vendor/bin/phpstan analyse -c phpstan.neon -l max src/
```
* PHPUnit
```bash
vendor/bin/phpunit
```
* PHPSpec
```bash
vendor/bin/phpspec run
```
* Behat (without Javascript)
```bash
vendor/bin/behat --tags="~@javascript"
```
* Behat (only Javascript)
```bash
vendor/bin/behat --tags="@javascript"
```
To run them all with a single command run:
```bash
composer suite
```
To run Behat's Javascript scenarios you need to setup Selenium and Chromedriver. Do the following:
1. 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
```
2. 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
```
License
-------
This library is under the MIT license. See the complete license in the LICENSE file.
Credits
-------
Developed by [Webgriffe®](http://www.webgriffe.com/).