Dev docs

Before start

Required software

Magento installation

Module development


Before start

Directory structure

You can use the following directory structure:

└── www
    ├── dev
    |   ├── satis               — Library that is used to build packages repository
    |   └── composer            — Manage module dependencies
    ├── logs                    — Apache, php, mysql logs
    └── public                  — Web server public folder
        ├── magento
        |   ├── htdocs          — Magento repository
        |   ├── vendor          — Magento modules
        |   └── composer.json   — List of modules to install with composer
        ├── packages            — Packages repository built with satis
        └── phpmyadmin

Required software


  1. Mysql server
  2. HeidiSql client
  3. PhpMyAdmin - Unpack it to www/public/phpmyadmin directory


  1. Download and unpack binaries to C:\php folder.
  2. Rename php.ini-development to php.ini
  3. Apply the following changes to php.ini:

    max_execution_time = 600
    memory_limit = 512M
    error_reporting = E_ALL
    error_log = "D:\www\logs\php_error.log"
    post_max_size = 256M
    doc_root = d:\www\public
    extension_dir = "ext"
    upload_max_filesize = 256M
    date.timezone = 'America/Los_Angeles'
  4. Add C:\php folder to system PATH


  1. Download and unpack binaries to /c/Apache24
  2. Find the following settings in conf/httpd.conf and change them as shown below:

    ServerRoot "c:/Apache24"
    Listen 80
    # LoadModule cgi_module modules/
    LoadModule rewrite_module modules/
    ServerName your_local_ip_address:80
    DocumentRoot "D:/www/public"
    AllowOverride All
    Require all granted
    <Directory "D:/www/public">
    DirectoryIndex index.php index.html
    ErrorLog "D:/www/logs/apache_error.log"
  3. Add the following settings to the bottom of the file:

    LoadModule php5_module "c:/php/php5apache2_4.dll"
    AddType application/x-httpd-php .php
    PHPIniDir "C:/php"


  1. Download and install

    • Add the git to the system PATH during installation
    • Select checkout as-is and commit as-is option
  2. Setup git

    git config --global "FirstName LastName"
    git config --global ""
    git config --global core.autocrlf false
    git config --global push.default simple
  3. Setup github account and generate ssh key


  1. Install composer
  2. Add composer to your github authorized applications and copy generated token.
  3. Run the following command in terminal:

    composer -g config YOUR_KEY_HERE


  1. Download satis

    cd www/dev
    composer create-project composer/satis --stability=dev --keep-vcs
  2. Add www/dev/satis/bin folder to system PATH variable.

Node.js and gulp.js

  1. Install Node.js
  2. Install Gulp.js

    npm install -g gulp

Magento installation


  1. Clone Speedupmate Magento repository:

    cd www/public/magento
    git clone htdocs
    cd htdocs
    git checkout magento-ce-
    echo '*' > .gitignore
    cp errors/local.xml.sample errors/local.xml
  2. Install magento sample data
  3. Open address in browser and install Magento
  4. Navigate to backend System > Configuration > Developer > Template Settings and set Allow Symlinks option to “Yes”
  5. Enable logs at System > Configuration > Developer > Log Settings configuration
  6. Disable cache at System > Cache Management

TM modules

  1. Download composer.json file and save it to www/public/magento folder.
  2. Run the following commands from terminal with admin privileges:

    cd www/public/magento
    composer install

    All modules will be automatically downloaded to the www/public/magento/vendor/tm folder and symlinked into www/public/magento/htdocs. So you can edit files in both vendor/tm and htdocs folders.

Module development

Module sort order

Use two or three letters of module code to determine the module sort order.

It’s recommended to use the two letters, bacause the third letter calculation is not accurate.

0 AjaxLayeredNav - aln
AjaxPro - apr
FireCheckout - fir

For Example:

Module Name Code for sortorder script Sort Order
AjaxLayeredNavigation aln 146
AjaxPro apr 161
EasyTabs eta 574
Full Page Cache fpc 659
Firecheckout fir 635

Making release

  1. Create build directory inside project root folder
  2. Add the following content to .gitingore:

  3. Copy these files from one of the following modules. Modify them according to your project name.

  4. Follow the build/ instructions
  5. Upload the generated archive to github release

Keep the modules up to date

  1. Commit all of your changes to github
  2. Update packages repository

    cd www/public/packages
    git pull
    satis build satis.json .
    git add .
    git commit -m "satis build satis.json ."
    git push
  3. Run terminal window with admin privileges.

    Do not run this command if you didn’t complete first or second step!

    cd www/public/magento
    composer update

    There is a chance that something will went wrong during composer update command. In case if all modules are downloaded by composer but not deployed to the magento folder, use the following command:

    composer run-script post-install-cmd -vvv -- --redeploy

Updating TM packages repository

TM packages repository is used by composer dependency manager to download module dependencies during composer install and composer update commands.

Clone tmhub/packages repository into www/public/packages if you didn’t do that before:

cd www/public
git clone packages

Update the repository and push changes:

cd www/public/packages
git pull
satis build satis.json .
git add .
git commit -m "satis build satis.json ."
git push



ConEmu is nice one.

Using GitBash in ConEmu:

Navigate to Settings > Startup > Tasks > New and create new tasks:

  1. GitBash

    Parameters: /dir "D:\www"
    Commands: "C:\Program Files (x86)\Git\bin\sh.exe" --login -i
  2. GitBash with admin privileges:

    Parameters: /dir "D:\www"
    Commands: "C:\Program Files (x86)\Git\bin\sh.exe" --login -i -new_console:a

Sublime text editor

  1. Download and install text editor
  2. Install Package Control
  3. Download sublime setting files and place them into %APPDATA%/Sublime Text 3/Packages/User
Edit this Page