Welcome, Guest Log In
Quickstart Guide
How to get going with Krai Framework with a minimum of knowledge

Linux Systems

Krai Framework is developed (for now), primarily with Linux support in mind. That is not to say it won't work on windows, but the developer just doesn't have a Windows box to do testing on.

As such, these directions may work for windows, but probably need a lot of tweaking.

Getting Krai Framework

Krai Framework can be downloaded from two places. First, official releases are available in the Google Code project download list. These are stable and beta releases available as Gzipped TARs.

The second option is to download the current Git repository head from the GitHub repository. There is the option to either clone the repository (which makes updates easier), or download a Gzipped TAR.

Creating an Application

The following code is a quick way to set up the structure for a new application. It assumes that you have downloaded the file "krai-XXXX.tar.gz" and are in a shell session in the same directory:

# Untar the downloaded file tar xzf krai-XXXX.tar.gz # Run the application generator to put the new application in # ./testapp/ and chmod the log files to 0777 ./krai-XXXX/script/newapp.sh -l -d . -n testapp

Application Configuration

Detailed application configuration is not in the scope of this article.
There is some general configuration that is needed, however. To configure the application, you need to edit the "includes/configs/krai.yml" file to reflect the place you will run the application.

Please see this page for full configuration options.

You will probably need to edit the testapp/public/.htaccess file as well to add/alter/remove the line
RewriteBase /testapp

Getting it Working

This assumes you are trying to run the application through an apache webserver. If you are trying something else and think it should be added here, just send an e-mail to this address

To get the application working, there are two options. First, you can use a symlink:

# Make the application available to the apache server where # the web root is /srv/httpd/html ln -s `pwd`/testapp/public/ /srv/httpd/html/testapp

The second option is to create an alias in the apache configuration.

Alias "/path/to/your/testapp/public/" /testapp <Directory "/path/to/your/testapp/public/"> AllowOverride All </Directory>

You should then (after an apache restart in the second case) be able to go to example.com/testapp (where example.com is the host you deployed on) and see Yay! Online!!.

For more complete information, see the README file.


Windows Systems

(coming sometime...)

Page Updated: Wed, Jul. 23rd 11:26 AM
Content Updated: Wed, Jul. 23rd 11:26 AM by Greg McWhirter (gsmcwhirter)
Krai Framework site admin credits sitemap valid xhtml?