# FlowDino Plugin A WooCommerce synchronization plugin that connects your product catalog to the FlowDino platform. ## Description FlowDino is a plugin that automatically synchronizes your WooCommerce products with the FlowDino platform. It provides a complete administration interface for managing synchronization, category mappings, brands, and attributes. ## Features - **Automatic synchronization**: Automatically syncs products when they are created or updated - **Manual synchronization**: Synchronize individual products or in bulk - **Category mapping**: Map your WooCommerce categories to FlowDino categories - **Brand mapping**: Support for popular brand plugins (WooCommerce Brands, Perfect Brands, YITH Brands) - **Attribute mapping**: Map colors, materials, and sizes to FlowDino attributes - **Variable products**: Full support for product variations - **Image synchronization**: Syncs main images and gallery images - **Stock management**: Synchronizes quantities and stock statuses - **Multilingual interface**: French and English support - **Synchronization statistics**: Dashboard with detailed statistics ## Installation 1. **Download**: Download the plugin from GitHub or your source 2. **Install**: - Via WordPress admin: Go to Plugins > Add New, click "Upload Plugin" and select the ZIP file - Via FTP: Unzip and upload the folder to `/wp-content/plugins/` 3. **Activate**: Activate the plugin in the WordPress Plugins section 4. **Configure**: Go to WooCommerce > FlowDino Sync to configure the plugin ## Configuration ### Basic Settings 1. **API URL**: FlowDino API URL (default: https://www.flowdino.com) 2. **Email**: Your FlowDino account email 3. **Password**: Your FlowDino password 4. **Automatic synchronization**: Enable/disable automatic synchronization 5. **Default color ID**: Default color ID for products without a color 6. **Default brand ID**: Default brand ID for products without a brand ### Category Mapping In the "Categories" tab, map each WooCommerce category to its corresponding FlowDino category. ### Brand Mapping Automatic support for brand plugins: - WooCommerce Brands - Perfect Brands for WooCommerce - YITH WooCommerce Brands ### Attribute Mapping Map your WooCommerce attributes (colors, materials, sizes) to the corresponding FlowDino attributes. ## Usage ### Automatic Synchronization Once enabled in settings, automatic synchronization is triggered: - When a new product is created - When an existing product is updated - When a product is deleted - When stock is updated ### Manual Synchronization 1. **Individual product**: In the "Products" tab, click "Synchronize" for a specific product 2. **Bulk synchronization**: Use the "Synchronize all products" or "Synchronize pending products" buttons ### Synchronization Tracking The "Products" tab displays: - Synchronization status for each product - Date of last synchronization - Any error messages - Global statistics ## Requirements - WordPress 5.0 or higher - WooCommerce 4.0 or higher - PHP 7.4 or higher - MySQL 5.6 or higher - Internet connection to access the FlowDino API ## File Structure ``` flowdino/ ├── flowdino.php # Main plugin file ├── includes/ # Core classes │ ├── class-flowdino-wc-api.php # API handler │ ├── class-flowdino-wc-admin.php # Administration interface │ ├── class-flowdino-wc-database.php # Database handler │ └── class-flowdino-wc-sync.php # Synchronization handler ├── assets/ # Front-end resources │ ├── admin.css # Admin styles │ └── admin.js # Admin scripts ├── languages/ # Translation files │ └── flowdino-fr_FR.po # French translation └── README.md # Documentation ``` ## Troubleshooting ### Connection Issues 1. Check your FlowDino credentials 2. Test the connection using the "Test connection" button 3. Verify that the API URL is correct 4. Make sure your server can access the Internet ### Synchronization Issues 1. Check the "Products" tab to view errors 2. Verify category and attribute mappings 3. Make sure products have the required information 4. Check WordPress logs for errors ## Support To get help: 1. Refer to this documentation 2. Check GitHub issues 3. Contact FlowDino support ## License This plugin is distributed under the GPL v2 or later license. ## Credits Developed by Jeremy DUMONT for FlowDino. ## Add your files - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files - [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command: ``` cd existing_repo git remote add origin https://gitlab.com/jeremdu/flowdinowoocommerce.git git branch -M main git push -uf origin main ``` ## Integrate with your tools - [ ] [Set up project integrations](https://gitlab.com/jeremdu/flowdinowoocommerce/-/settings/integrations) ## Collaborate with your team - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) - [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/) ## Test and Deploy Use the built-in continuous integration in GitLab. - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/) - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) *** # Editing this README When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. ## Suggestions for a good README Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. ## Name Choose a self-explaining name for your project. ## Description Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. ## Badges On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. ## Visuals Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. ## Installation Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. ## Usage Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. ## Support Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. ## Roadmap If you have ideas for releases in the future, it is a good idea to list them in the README. ## Contributing State if you are open to contributions and what your requirements are for accepting them. For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. ## Authors and acknowledgment Show your appreciation to those who have contributed to the project. ## License For open source projects, say how it is licensed. ## Project status If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.