Skip to content

A Magento module that makes your catalog load nearly instant while SEO proof & scales to >100k products

License

Notifications You must be signed in to change notification settings

techtribe/magento-instant-catalog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Magento Instant Catalog

A Magento module that makes your catalog load nearly instant while SEO proof & scales to >100k products

How to develop

Development environment

This development environment is the based on the Magento docker setup. Only sample data is added. For more information see https://devdocs.magento.com/cloud/docker/docker-development.html

Prerequisites

We assume the following software is installed:

  • PHP version 7.1 or later
  • Composer
  • Docker
  • mutagen

Initialisation

cd magento2/
composer install
bin/magento-docker up
bash mutagen.sh

Now wait about 60 sec for the filesystems to sync (Host and docker filesystems). Then run (This will take ~20min...):

docker-compose run deploy cloud-deploy
docker-compose run deploy magento-command deploy:mode:set developer
docker-compose run deploy magento-command cache:disable layout block_html full_page

Now the system should be working under the following URL: https://magento2.docker & https://magento2.docker/admin

To be able to access the admin panel create a user:

bin/magento-docker bash
bin/magento admin:user:create

Kibana

If you want to know what is going on within ElasticSearch, Kibana is installed and can be reached here: http:https://magento2.docker:5601.

For more information check https://www.elastic.co/guide/en/kibana/current/getting-started.html or use Google.

xDebug on/off

Using xDebug during development is highly recommended. Though it will slowdown the system substantially. So keep in mind turning it off before starting heavy tasks.

To manage xDebug a helper script can be used. It's not battle tested but should do the job:

cd magento2/

# Turn xDebug on
bash xdebug.sh on

# Turn xDebug off
bash xdebug.sh off

Do make sure your IDE is configured correct. Settings are:

Port = 9002
PathMapping = $ROOT/magento2:/app
Host = magento2.docker
IDEKey = PHPSTORM

Useful commands

bin/magento-docker stop
bin/magento-docker start
bin/magento-docker bash
bash xdebug.sh on
bash xdebug.sh off
mutagen sync list

Possible issues

KILLED message

If you ever face a killed message have a look here: https://stackoverflow.com/questions/44417159/docker-process-killed-with-cryptic-killed-message

File changes don't effect the system

Check if mutagen is running by running this command:

mutagen sync list

You should see a sync config which is active. If not run:

bash magento2/mutagen.sh

Contributors

About

A Magento module that makes your catalog load nearly instant while SEO proof & scales to >100k products

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published