Extension:Jade/Development

Thank you for your interest in contributing to Jade.

Please refer to the Jade README for an end-to-end Jade development setup.

There are mainly two ways in which you can setup a local development environment for Jade as explained below;
 * 1) MediaWiki-Docker Setup
 * 2) MediaWiki-Vagrant Setup

{| role="presentation" class="wikitable mw-collapsible mw-collapsed" style="width:100%;"
 * How to setup a Jade development environment using MediaWiki-Docker

Docker Requirements

 * 1) Docker
 * 2) Docker Compose
 * 3) A gerrit account and properly configured git

Docker Instructions
You should now be able to visit http://localhost:8080/index.php?title=Special:Version and confirm that the extension has been installed.
 * 1) Install MediaWiki-Docker:
 * 2) Follow the instructions in DEVELOPERS.md to get Docker running
 * 3) Next, do the following:
 * }

{| role="presentation" class="wikitable mw-collapsible mw-collapsed" style="width:100%;"
 * How to setup a Jade development environment using MediaWiki-Vagrant

Vagrant Prerequisites
System requirements
 * Linux, macOS, or Windows
 * 64 bit
 * 8 GB RAM
 * 15+ GB Disk space

Environment Software
 * Gerrit account
 * Git
 * NFS - for Ubuntu run this command:
 * VirtualBox
 * Vagrant

Vagrant Set-Up
Step 1: Download the mediawiki-vagrant zip, unzip it and add it to your project's directory. So at this point you have something like: ~/path-to-project-directory/vagrant

Step 2: Download MediaWiki using this command: git clone --depth=1 "ssh://@gerrit.wikimedia.org:29418/mediawiki/core  This download will take some time to complete. When it's done, copy the contents of the "core" directory you've just downloaded and move them to  ~/path-to-project-directory/vagrant/mediawiki

Step 3: Download the MW vendor directory using this command: git clone "ssh://@gerrit.wikimedia.org:29418/mediawiki/vendor.git"  Add contents of the "vendor" directory you've just downloaded to  ~/path-to-project-directory/vagrant/mediawiki/vendor

Step 4: Go to  and create your virtual machine using this command:

Step 5: Once all the steps above have completed successfully, you can log into your VM using this command:  Or visit your mediawiki instance in the browser: http://dev.wiki.local.wmftest.net:8080/

Conslusion
Congratulations on setting up your MW-Vagrant environment. Hope these steps have helped you to easily set it up. In case you would like to learn more, please visit the official MW-Vagrant documentation MediaWiki-Vagrant.

Extra Tips for the Vagrant setup

 * 1) Remember to set your git username and email using:  git config --global user.name "" && git config --global user.email ""
 * 2) Remember to setup the Gerrit commit-msg hook in the root of your working directory i.e go to root of extension or skin you're working on and run:
 * 3) Remember to move your ssh keys from your local machine to your vagrant VM in
 * 4) If you'd like to start the MW-Vagrant set-up afresh, remember to delete;
 * the entire vagrant directory:
 * the virtual machine created in virtualbox:
 * the NFS settings file:
 * Then restart your machine and create;
 * the NFS settings file:
 * a new vagrant directory e.g vagrant02:
 * Then move on to Vagrant set-up step1.


 * }

In case you have any questions while contributing to Jade, please reach out to the Scoring Platform team. We shall be happy to help.