{"id":15287376,"url":"https://github.com/cooptilleuls/cooptilleulssyliusclickncollectplugin","last_synced_at":"2025-04-07T05:12:38.641Z","repository":{"id":43482486,"uuid":"249144590","full_name":"coopTilleuls/CoopTilleulsSyliusClickNCollectPlugin","owner":"coopTilleuls","description":"Sell and deliver securely during the COVID-19 pandemic!","archived":false,"fork":false,"pushed_at":"2023-09-28T14:14:44.000Z","size":5715,"stargazers_count":78,"open_issues_count":13,"forks_count":34,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-03T00:15:27.963Z","etag":null,"topics":["click-and-collect","covid-19","covid-virus","covid19","sylius","sylius-plugin","symfony","symfony-bundle"],"latest_commit_sha":null,"homepage":"https://click-n-collect.shop","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coopTilleuls.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-03-22T08:46:08.000Z","updated_at":"2024-05-06T00:17:11.000Z","dependencies_parsed_at":"2023-01-27T17:31:19.262Z","dependency_job_id":"82c33639-cb54-42be-b9d1-145fa6df4c14","html_url":"https://github.com/coopTilleuls/CoopTilleulsSyliusClickNCollectPlugin","commit_stats":{"total_commits":62,"total_committers":17,"mean_commits":"3.6470588235294117","dds":0.5967741935483871,"last_synced_commit":"1bbf69d3f5fafc756e5d6339cc2ae0c2fdc3e982"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coopTilleuls%2FCoopTilleulsSyliusClickNCollectPlugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coopTilleuls%2FCoopTilleulsSyliusClickNCollectPlugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coopTilleuls%2FCoopTilleulsSyliusClickNCollectPlugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coopTilleuls%2FCoopTilleulsSyliusClickNCollectPlugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coopTilleuls","download_url":"https://codeload.github.com/coopTilleuls/CoopTilleulsSyliusClickNCollectPlugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595335,"owners_count":20963943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["click-and-collect","covid-19","covid-virus","covid19","sylius","sylius-plugin","symfony","symfony-bundle"],"created_at":"2024-09-30T15:27:59.166Z","updated_at":"2025-04-07T05:12:38.622Z","avatar_url":"https://github.com/coopTilleuls.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv style=\"display: flex; flex-direction:row; align-items: center;justify-content: space-around\"\u003e\n    \u003ca href=\"https://click-n-collect.shop\" target=\"_blank\"\u003e\n       \u003cimg src=\"docs/img/logo.svg\" alt=\"Click 'N' Collect\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://sylius.com/plugins/\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://sylius.com/assets/badge-approved-by-sylius.png\" width=\"120\" alt=\"Approved by Sylius\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n**Sell and hand over securely during the coronavirus pandemic!**\n\nBecause of the coronavirus pandemic, a large part of the world is under lockdown and most shops are closed or with long queues.\n\n**Sylius Click 'N' Collect** is a solution to sell and hand over your products **safely** during the lockdown (and even after that).\nBy allowing **contactless** pick up and preventing queues, **Sylius Click 'N' Collect** protects your workers and your customers.\n\n**Sylius Click 'N' Collect** is a plugin for the [Sylius](https://sylius.com/) eCommerce platform.\n[It's free](#license) (as in speech, and as in beer), and it's brought to you by your friends from [Les-Tilleuls.coop](https://les-tilleuls.coop). It can also be used in addition to all the existing features and plugins of Sylius.\n\n![CI](https://github.com/coopTilleuls/CoopTilleulsSyliusClickNCollectPlugin/workflows/CI/badge.svg)\n\n## How Does It Work?\n\n[![Screencast](https://i.imgur.com/yOU3sw7.png)](https://www.youtube.com/watch?v=bQ9_vQJf-2I)\n\nAs a customer:\n\n1. Go on the shop's website\n2. Select the products to order\n3. Select the collect location (e.g. the physical shop)\n4. Select an available time slot\n5. Pay online, or select in-store payment (Stripe and PayPal are also supported).\n6. Optional: a PIN is generated, you'll need it to retrieve the order\n7. Pick up your order at the shop during the selected time slot! Use the PIN code to unlock the box if appropriate.\n\nAs a seller:\n\n1. Use the timetable in the admin interface to see the upcoming orders\n2. Prepare the orders: put them in a bag and make the order number noticeable (staple it or use a marker)\n3. Clean carefully the shelf and the lock (if appropriate) with the appropriate cleaning products\n4. Put the bag in the shelf\n5. Optional: use the PIN to lock the box in the shelf to secure the order\n6. Monitor the pick up from afar, from behind a window, or using CCTV\n\nRepeat!\n\nYou're now selling while preventing the pandemic to spread!\n\n## Install\n\nNote: to test the plugin locally, see [CONTRIBUTING.md](CONTRIBUTING.md)\n\n1. [Install Sylius](https://docs.sylius.com/en/latest/book/installation/installation.html)\n2. Install **Sylius Click 'N' Collect**: `composer require tilleuls/sylius-click-n-collect-plugin`\n3. Register the bundle:\n\n    ```php\n    \u003c?php\n    \n    // config/bundles.php\n\n    return [\n        // ...\n        CoopTilleuls\\SyliusClickNCollectPlugin\\CoopTilleulsSyliusClickNCollectPlugin::class =\u003e ['all' =\u003e true],\n    ];\n\n4. Import the configuration:\n\n    ```yaml\n    # config/packages/sylius_click_n_collect.yaml\n    imports:\n        - { resource: \"@CoopTilleulsSyliusClickNCollectPlugin/Resources/config/app/config.yml\" }\n     ```\n\n5. Import the routes:\n\n    ```yaml\n    # config/routes/sylius_click_n_collect.yaml\n    coop_tilleuls_sylius_click_n_collect_shop:\n        resource: \"@CoopTilleulsSyliusClickNCollectPlugin/Resources/config/shop_routing.yml\"\n        prefix: /{_locale}\n        requirements:\n            _locale: ^[a-z]{2}(?:_[A-Z]{2})?$\n    \n    coop_tilleuls_sylius_click_n_collect_admin:\n        resource: \"@CoopTilleulsSyliusClickNCollectPlugin/Resources/config/admin_routing.yml\"\n        prefix: /admin\n    ```\n\n6. Update the native entities:\n\n    ```php\n    \u003c?php\n    \n    // src/Entity/Shipping/ShippingMethod.php\n    \n    namespace App\\Entity\\Shipping;\n    \n    use CoopTilleuls\\SyliusClickNCollectPlugin\\Entity\\ClickNCollectShippingMethod;\n    use CoopTilleuls\\SyliusClickNCollectPlugin\\Entity\\ClickNCollectShippingMethodInterface;\n    use Doctrine\\ORM\\Mapping as ORM;\n    use Sylius\\Component\\Core\\Model\\ShippingMethod as BaseShippingMethod;\n    \n    /**\n     * @ORM\\Entity\n     * @ORM\\Table(name=\"sylius_shipping_method\")\n     */\n    class ShippingMethod extends BaseShippingMethod implements ClickNCollectShippingMethodInterface\n    {\n        use ClickNCollectShippingMethod {\n            __construct as initializeShippingMethodLocations;\n        }\n    \n        public function __construct()\n        {\n            parent::__construct();\n    \n            $this-\u003einitializeShippingMethodLocations();\n        }\n    \n        // ...\n    }\n    ```\n\n    ```php\n    \u003c?php\n    \n    // src/Entity/Shipping/Shipment.php\n    \n    namespace App\\Entity\\Shipping;\n    \n    use CoopTilleuls\\SyliusClickNCollectPlugin\\Entity\\ClickNCollectShipment;\n    use CoopTilleuls\\SyliusClickNCollectPlugin\\Entity\\ClickNCollectShipmentInterface;\n    use CoopTilleuls\\SyliusClickNCollectPlugin\\Validator\\Constraints\\SlotAvailable;\n    use Doctrine\\ORM\\Mapping as ORM;\n    use Sylius\\Component\\Core\\Model\\Shipment as BaseShipment;\n    \n    /**\n    * @ORM\\Entity\n    * @ORM\\Table(name=\"sylius_shipment\", indexes={@ORM\\Index(columns={\"location_id\", \"collection_time\"})})\n    * @SlotAvailable(groups={\"sylius\"})\n    */\n    class Shipment extends BaseShipment implements ClickNCollectShipmentInterface\n    {\n       use ClickNCollectShipment;\n    }\n    ```\n\n7. Override the templates:\n\n       cp -R vendor/tilleuls/sylius-click-n-collect-plugin/tests/Application/templates/* templates\n\n8. Create and execute database migrations:\n\n       bin/console doctrine:migrations:diff\n       bin/console doctrine:migrations:migrate\n\n9. Copy the assets\n\n       bin/console assets:install\n       bin/console sylius:theme:assets:install\n\n10. Add your products and stocks or [import them](https://github.com/coopTilleuls/CoopTilleulsSyliusQuickImportPlugin)\n11. Configure the pick up locations, the available time slots, and how many people you can safely serve in parallel\n12. Create a dedicated shipping method\n13. Optionally, configure an online payment method from the admin (Stripe and PayPal are supported out of the box)\n\n**Export data**\n\nsee [docs/exports.md](docs/exports.md)\n\n**You're ready to sell!**\n\n# License\n\n## Pandemic Clause\n\nTo use this software, you **MUST** ensure that all the workers and customers using it aren't at risk!\nIt means that you **MUST** reduce the number of contacts between the workers and customers (in most cases the delivery should be contactless),\nand that you **MUST** provide masks, hand sanitizers and gloves to the workers who handle products.\n\nLives matter more than profits.\n\n## AGPL\n\nSylius Click 'N' Collect is licensed under [AGPL-3.0](LICENSE).\nFor companies not wanting, or not able to use AGPL-3.0 licensed software, commercial licenses are also available.\n[Contact us for more information](mailto:contact@les-tilleuls.coop).\n\n# Credits\n\nCreated by [Kévin Dunglas](https://dunglas.fr) for [Les-Tilleuls.coop](https://les-tilleuls.coop).\nCommercial support available at [Les-Tilleuls.coop](https://les-tilleuls.coop).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcooptilleuls%2Fcooptilleulssyliusclickncollectplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcooptilleuls%2Fcooptilleulssyliusclickncollectplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcooptilleuls%2Fcooptilleulssyliusclickncollectplugin/lists"}