Added readme, development.txt and images

lima195 · Jun 15, 2020 · 5552e6f · 5552e6f
1 parent 1df300c
commit 5552e6f
Show file tree

Hide file tree

Showing 15 changed files with 81 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,60 @@
+Install this package using the composer:
+	https://packagist.org/packages/lima/movies (version 1.0.4)
+
+Considerations:
+	- The module was built following the best practices of Magento, using ui components, ko javascript, saving data with queue repository, interfaces and queue with cron.
+	- I tried so hard to use ui components to retrieve items from the API, but nothing works, I got overlaping block collection (without ui components), but the pagination, the total of items and the filter were not working well. After many tries, my best solution for this was to use a block model and ko scripts to create a table and an ajax form to retrieve items from the API (keeping magento 2 admin theme at most). All other admin grid uses best practices with full-featured ui components (except in-line editing).
+	- I chose to use the queue system with cron to import products, but the queue import can be forced with the bulk action import (admin grid queue).
+	- I have some versions on packgist because I never put a projeto into packgist and I had to do some tests.
+
+This module contains the following resources:
+	1 - Set a default value for products like 'price', 'stock' and 'attribute_set'
+	2 - Define the default search terms, such as 'language' and 'adult'
+	3 - Import movie with custom price or stock (this overlaps with default 'price' or 'price'), you can override these values in the search results table, just before import
+	4 - Movies import through the queuing system (using cron). After searching and importing the selected results, this movie goes to a queue import and then becomes a product
+	5 - The queuing system uses cron to import products
+	6 - You can add a movie as one of your favorite in the catalog page view clicking "Add to favorites" button next to "Add to wish list" or "Add to compare"
+	7 - This module can be installed with the composer (https://packagist.org/packages/lima/movies)
+	8 - ACL for all resources
+
+Demo images:
+
+* Menu
+![alt text](https://github.com/lima195/Lima_Movie/images/01_menu.png)
+
+* System configuration
+![alt text](https://github.com/lima195/Lima_Movie/images/02_config.png)
+
+* Search Movie Results
+![alt text](https://github.com/lima195/Lima_Movie/images/03_search_movie.png)
+
+* Setup custom price
+![alt text](https://github.com/lima195/Lima_Movie/images/04_setup_custom_price.png)
+
+* Confirm Import
+![alt text](https://github.com/lima195/Lima_Movie/images/05_import_confirm.png)
+
+* Import Movie Queue (waiting cron process)
+![alt text](https://github.com/lima195/Lima_Movie/images/06_import_movie_queue.png)
+
+
+* Force Import
+![alt text](https://github.com/lima195/Lima_Movie/images/07_import_movie_queue_force.png)
+
+* Import Success
+![alt text](https://github.com/lima195/Lima_Movie/images/08_import_movie_success.png)
+
+* Favorite List Before
+![alt text](https://github.com/lima195/Lima_Movie/images/09_movie_favorite_list_before.png)
+
+* Search Movie Results (frontend)
+![alt text](https://github.com/lima195/Lima_Movie/images/10_movie_search_result_frontend.png)
+
+* Product View
+![alt text](https://github.com/lima195/Lima_Movie/images/11_movie_view.png)
+
+* Added as favorite
+![alt text](https://github.com/lima195/Lima_Movie/images/12_movie_add_favorite.png)
+
+* Favorite List Now (This collection has a group by product_id, count and limit 10 in _initSelect() on collection file)
+![alt text](https://github.com/lima195/Lima_Movie/images/13_movie_favorite_list.png)
diff --git a/development.txt b/development.txt
@@ -0,0 +1,21 @@
+Install this package using the composer:
+	https://packagist.org/packages/lima/movies (version 1.0.4)
+
+Considerations:
+	- The module was built following the best practices of Magento, using ui components, ko javascript, saving data with queue repository, interfaces and queue with cron.
+	- I tried so hard to use ui components to retrieve items from the API, but nothing works, I got overlaping block collection (without ui components), but the pagination, the total of items and the filter were not working well. After many tries, my best solution for this was to use a block model and ko scripts to create a table and an ajax form to retrieve items from the API (keeping magento 2 admin theme at most). All other admin grid uses best practices with full-featured ui components (except in-line editing).
+	- I chose to use the queue system with cron to import products, but the queue import can be forced with the bulk action import (admin grid queue).
+	- I have some versions on packgist because I never put a projeto into packgist and I had to do some tests.
+
+This module contains the following resources:
+	1 - Set a default value for products like 'price', 'stock' and 'attribute_set'
+	2 - Define the default search terms, such as 'language' and 'adult'
+	3 - Import movie with custom price or stock (this overlaps with default 'price' or 'price'), you can override these values in the search results table, just before import
+	4 - Movies import through the queuing system (using cron). After searching and importing the selected results, this movie goes to a queue import and then becomes a product
+	5 - The queuing system uses cron to import products
+	6 - You can add a movie as one of your favorite in the catalog page view clicking "Add to favorites" button next to "Add to wish list" or "Add to compare"
+	7 - This module can be installed with the composer (https://packagist.org/packages/lima/movies)
+	8 - ACL for all resources
+
+See readme for demo images
+I tooked almost 3 weekends to finish this.
diff --git a/images/01_menu.png b/images/01_menu.png
diff --git a/images/02_config.png b/images/02_config.png
diff --git a/images/03_search_movie.png b/images/03_search_movie.png
diff --git a/images/04_setup_custom_price.png b/images/04_setup_custom_price.png
diff --git a/images/05_import_confirm.png b/images/05_import_confirm.png
diff --git a/images/06_import_movie_queue.png b/images/06_import_movie_queue.png
diff --git a/images/07_import_movie_queue_force.png b/images/07_import_movie_queue_force.png
diff --git a/images/08_import_movie_success.png b/images/08_import_movie_success.png
diff --git a/images/09_movie_favorite_list_before.png b/images/09_movie_favorite_list_before.png
diff --git a/images/10_movie_search_result_frontend.png b/images/10_movie_search_result_frontend.png
diff --git a/images/11_movie_view.png b/images/11_movie_view.png
diff --git a/images/12_movie_add_favorite.png b/images/12_movie_add_favorite.png
diff --git a/images/13_movie_favorite_list.png b/images/13_movie_favorite_list.png