NAME

helix - Helix Framework application code generator.

SYNOPSIS

helix [options] <application_name>

Options:

    -t --type       application type:
                        cgi  - CGI application (default)
                        fcgi - FastCGI application
    -v --verbose    verbose output
    -h --help       print this help

Examples:

    helix -t cgi -v Example
    helix -t fcgi AnotherExample
    helix ThirdExample

DESCRIPTION

The helix code generator will help you to create the application skeleton, so you won't need to make applications from scratch. It creates a simple example application with 2 controllers (default page and error controllers) and a basic configuration without any drivers.

The application name must consist of 1 or more alphanumeric characters.

Using the example application name Example and CGI application type, the application directory will contain the following items:

cgi-bin/

A directory with executable contents. All your application scripts and modules are placed here. Contents of this directory should be moved into cgi-bin directory on your web server.

index.cgi

CGI gateway of the application. All user requests will come through this file.

lib/

A directory containing all application modules. If your application will use other modules, place them here too.

Example.pm

A main module of the application. Contains almost nothing - some subclassing stuff and application version definition.

Example/

A directory with application configuration and other stuff used to interact with Helix Framework .

Config.pm

Application configuration. Generated configuration contains only basic settings, so you should edit this file first and specify application settings manually.

Controller/

A directory containing application controllers.

_Error.pm

An error controller of the application.

Default.pm

A default controller of the application.

static/

A directory containing static data - images, stylesheets and javascript. Contents of this directory should be moved into htdocs (httpdocs, www, wwwroot) directory on your web server.

_htaccess

Apache configuration file. Contains mod_rewrite rules for the application. Rename this file to .htaccess while copying the application into web server directories.

img/

A directory containing images for the application.

flag.png

Nice flag image :)

logo.png

Helix Framework logo.

The application directory for the FastCGI application type will be the same, except the cgi-bin/index.cgi file - in FastCGI version there will be cgi-bin/index.fcgi file instead.

NOTES

The application generated using this script will work only on Apache web server with mod_rewrite module installed. Support of other servers will be added in future versions of this script.

To make your application work perform the following actions:

1. copy the cgi-bin directory contents into the cgi-bin directory on your web server.

2. set rwx-r-x-r-x permissions on cgi-bin/index.cgi (or cgi-bin/index.fcgi) file.

3. copy the static directory contents into the htdocs (httpdocs, www, wwwroot) directory on your web server.

4. rename the static/_htaccess file into static/.htaccess. Possibly, you will not need edit this file, but it may be needed if the cgi-bin directory of your web server is located outside the web server's root (htdocs, httpdocs, www, wwwroot or something like that).

SEE ALSO

Helix, Helix::Application

http://www.atma7.com/products/helix/ - official project web page.

LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Anton Belousov, <abel@cpan.org>

COPYRIGHT

Copyright (c) 2009, Atma 7, http://www.atma7.com