Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 1.88 KB

README.md

File metadata and controls

46 lines (36 loc) · 1.88 KB
Raw

SxRequireJs

Version 0.1.0 Created by Wesley Overdijk

Introduction

This is a simple RequireJS module for Zend Framework 2 (from here referred to as ZF2). It allows you to use RequireJs within ZF2 by setting up modules / paths and adding applications.

Installation

Composer (recommended)

The recommended way to get this module working, is to add it to your composer.json, and then doing a php composer.phar update.

Git clone installation

  1. Clone this module into your vendor directory. (usually /path/to/application/vendor) like this:
cd my/project/dir/vendor
git clone git://github.com/RWOverdijk/SxRequireJs.git
  1. Enable this module in your application.config.php.

Getting it working

SxRequireJs doesn't work out of the box. It has its own public directory and therefore the RequireJS file will not be accessible. To get this working, there are a couple of things you can do.

  1. Add an AliasMatch to your vhost (recommended). Example: AliasMatch ^/([a-zA-Z0-9]+)/(css|img|js)/(.*) /Path/To/Your/Application/module/$1/public/$2/$3 Note: This does require you to add a directory to your vhost to allow access outside of your DocumentRoot.

  2. Copy the js in the public directory to your application's public directory.

  3. Set up symbolic links to map the module's public dir to the application's public dir

  4. Write an .htaccess that allows access to module public directories

Usage and configuration

You can find more information, the configuration options and some usage examples in the SxRequireJs wiki.

TODO

  • Format generated output (white spaces)
  • Add versions support in a intuitive manner
  • translate support
  • Building translation files from Zend\I18n\Translate
  • Build in optimizer support