Skip to content

Install, configure and build

Jump to bottom Edit New page
Victor Jonsson edited this page Mar 2, 2015 · 13 revisions

Here's what you need to do if you want to contribute to the Arlima project.

  1. Install node and npm
  2. Install grunt by calling npm install -g grunt-cli in your console
  3. Install the node modules needed to run the grunt tasks by calling npm install in your console, inside the Arlima directory
  4. Open up wp-config.php and add define('ARLIMA_DEV_MODE', true). This will make Arlima use the development versions of the javascripts and build the less files in the browser.

Now you can call the grunt tasks for Arlima!

 current-version  Get current version                                                   
  change-version  Bump up the version number, or change version name by adding 
                  --new-version=3.1.0                                          
     validate-js  Check that we're not doing anything wrong in our javascripts 
        build-js  Alias for "validate-js", "current-version", "concat",        
                  "uglify", "change-version" tasks.                            
     create-docs  Create markdown-formatted class documentation in             
                  classes/docs.md                                              
         phpunit  Run phpUnit tests                                            
    localization  Translate .pot-files                                         
 validate-readme  Validate readme.txt                                          
  create-release  Copy source code to release directory                        
         default  Alias for "composer", "phpunit", "validate-js",              
                  "validate-readme", "change-version", "localization",         
                  "create-docs", "less", "concat", "uglify" tasks.

PHPunit

To be able to run the unit tests you must install phpunit and add it to your PATH. It also requires that you have a local installation of WordPress. Notice! The tests does not mock WordPress nor the database. The tests will actually create stuff in your WordPress database so you should never run them in a production environment.

Localization

Translating the pot files requires that you have msgfmt (binary that's shipped with gettext) installed and added to your PATH.

Add a custom footer

This Wordpress plugin was created by Swedish newspaper Västerbottens-Kuriren to give its editorial staff an easy to use tool for customizing the front pages of their online magazines.

Installing Arlima

  1. Download the latest release from github and unzip the folder in your plugin directory.
  2. Open up wp-admin and activate the plugin.
  3. Go to "Article lists" -> "Edit lists" in wp-admin and create your first article list.
  4. Open up a page (or create it) in wp-admin. Down to the right you will see a meta box labeled "Arlima" where you choose the list that you created on step 2.
  5. Go to "Article lists" -> "Manage lists" and start stuffing your article list with interesting content.

Top links

Clone this wiki locally