<!-- TITLE: Feed - Magento 2 module documentation -->
<!-- SUBTITLE: Autor: Lukas Paliwoda -->
# Feed Module
## Module overview
Our module adds functionality for generate product feeds that allows promote your products in popular shoping channels. With easy confuguration you can generate feeds manually or schedule automatic tasks. This exposure your shop to wider customer range and increase your products sales.
## Module compatibility
This module is compatibile with Magento Community versions: **2.2**, **2.3** and **2.4**.
## How it works
After installing the module, you will get two menu items in Admin Panel which first of them takes you to product feeds grid.
In products feeds grid you can add another feed for your products.
To create new feed you need to specify basic fields like name, filename, fequency of generation and template. You can also add additional conditions to your products feeds list.
**After saving**, the feed can be generated using the **Generate** option or automatically generated according to the set frequency.
**ATTENTION!** To generate correct content of the file, it is necessary to save it before selecting the "Generate" option
The second option allows you to create mappings for categories. After switching to Mapping Categories you will be redirected to the grid.
To create a mapping, complete the basic configuration fields such as code, name and we can exclude selected categories from the mapping. After creating the record, you can edit it to add mapping names.
Module configuration can be found in Stores -> Configuration under Catalog -> Catalog menu.
Module configuration covers basic functionality like enable/disable module, specify directory path for generated feeds or schedule automaticaly feed generaion.
## Demo
demo1.magecreation.com
## Installation
### Composer
* Add repo to composer.json:
```text
"repositories": [
...
{
"type": "vcs",
"url": "git@git.auroracreation.com:magento2/feed.git"
}
...
],
```
* Add package to composer.json:
```text
"require": {
...
"aurora/feed": "~1.5"
...
},
```
* In Magento root folder run commands:
```text
$ composer update aurora/feed
$ php bin/magento module:enable Aurora_Feed
$ php bin/magento setup:upgrade
```
### Manual
1. Unzip archive.
2. Upload extension files on your server to:
```text
{Magento root}
└── app/
└── code
```
3. In Magento root folder run commands:
```text
php bin/magento module:enable Aurora_Feed
php bin/magento setup:upgrade
```
## Change log
### v2.0.0
* The feed generation process has been modified
* Moved the manual feed generation button to the form
* Added progress bar display during manual generation
* Added configuration field - number of products per page when manually generating the feed
* The file template has been modified - the template has been divided into 3 parts - header, content and footer
### v1.10.0
* Code refactoring
### v1.9.2
* Code improvement for Magento 2.4.5
### v1.9.1
* Excluding inactive categories from the filter
### v1.8.23
* Adding display of description without tags
### v1.8.22
* Changing accesses to some functions
### v1.8.21
* Changing the way to create a path to a category
### v1.8.20
* Improved URL creation
### v1.8.19
* Bug fix for empty tables
### v1.8.18
* Changes to ProdcutAdapter
### v1.8.17
* Fix to problematic method.
### v1.8.15
* Creating a new method to display galleries
### v1.8.14
* Adding a default theme
### v1.8.13
* Mapping fix
### v1.8.12
* Improved mapping
### v1.8.11
* Bug fixes
### v1.8.10
* Addition of color selection for names
### v1.8.9
* Bug fixes
### v1.8.8
* Bug fixes
### v1.8.7
* Registry fix
### v1.8.6
* Registry fix
### v1.8.5
* Fixing of some buttons
### v1.8.4
* Refactoring of the code
### v1.8.3
* Improvement of database schema
### v1.8.2
* Bug fixes
### v1.8.1
* Bug fixes