Download and Installation Instructions

To download latest version of the framework, visit the Raxan Download web page located at http://raxanpdi.com/downloads.html. If you're a PHP developer and would like to use the built-in PHP/Ajax features, then you need to download the Raxan for PHP zip file. If you're only looking for the JavaScript/CSS framework then download Raxan for CSS zip file.

For a list of basic requirements see "Software Requirements"

Installation

After downloading the file, unzip the content of the file (e.g. raxan-php.1.0.0.zip or raxan-css.1.0.0.zip) into a folder on your local PC (e.g. c:\development\raxanfiles) or your web server. Installing Raxan is as simple as copying the files and folders to another server or folder location. No special installation program or script is required.

Note: When installing on a web server, make sure that the files are placed in a location on your web server (e.g. the web root folder) that can be accessed via a browser.

Directory Structure

Inside the main Raxan folder you will find the file startup.js. This is the framework's main JavaScript startup file. The plugins folder is used for storing Raxan plugins or other JavaScript library files. For example, you can add files to the plugins folder such as jQuery, mootools, etc and dynamically include them when needed. Later on, we will look at how to include JavaScript libraries when needed.

The styles folder is used for storing cascading style sheets and images. Inside this folder you will find the master.css file that contains the CSS classes for building complex layouts. In addition, you will also find a default folder that contains the default theme for the framework. Additional themes can be added and optionally loaded when necessary.

The templates folder is basic a storage area for html templates that can be used to help simplify or speed up development.

The PDI folder is only available if you had downloaded the PDI version of the framework. This folder stores the Raxan Classes, locale and sample configuration files.

If you would like to adjust the default settings or behavior, you can optionally create a configuration file for your project or website.

Creating a PDI Configuration File

To create your custom configuration file, copy (or rename) the raxan/pdi/gateway.config.sample.php to gateway.config.php

Using a text editor, edit the content of gateway.config.php by adding the necessary folder paths and/or database login information.

On shared linux systems you should set your config file to 644 or 600 to prevent others from making changes to your config settings. It's also recommended that your ISP run the suphp Apache module for added security.

Changing the default Raxan Path

JavaScript developers can optionally change the default path by setting the 'path' property on the Raxan object. For example: Raxan.path = '/path/to/raxan/'. The same can be done for the csspath and pluginspath. Note: The new url must have a trailing slash (/)

For PHP developers, set the raxan.url and raxan.path options inside your gateway.config.php file. For more information see Loading A Custom Configuration File

<?php

$config['raxan.url'] = '/url/address/to/raxan/';
$config['raxan.path'] = '/folder/path/to/raxan/';

?>