NAME

helix - Helix Framework application code generator.

SYNOPSIS

helix [options] <application_name>

Options:

    -v --verbose    verbose output
    -h --help       print this help

Examples:

    helix -v Example
    helix AnotherExample

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 one default controller and a basic configuration with Helix::Driver::Router::Basic as a router driver, so you need this package to be installed.

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

Using the example application name Example the application directory will contain the following items:

bin/

A directory with executable contents. All your application scripts 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.

index.fcgi

FastCGI gateway of the application. You need to install the FCGI module to use this type of gateway.

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.

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 or wwwroot) directory of your web server.

config/

Web-server configuration files.

apache_cgi

Apache configuration file for CGI application. Contains mod_rewrite rules for the application. Rename this file to .htaccess while deploying the application to web server.

apache_fcgi

Apache configuration file for FastCGI application. Rename this file to .htaccess while deploying the application to web server.

img/

A directory containing images for the example application.

flag.png

Nice flag image :)

logo.png

Helix Framework logo.

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.

DEPLOYMENT

To deploy your application perform the following actions:

1. Copy one of the files in bin directory into the cgi-bin directory of your web server. For CGI application, you should copy a index.cgi, for FastCGI application - copy a index.fcgi file.

2. Set rwxr-xr-x (755) permissions on file that you copied at first step (i.e. index.cgi or index.fcgi).

3. Copy the lib directory to the same directory, where your web-server's cgi-bin is located. Actually, you can place this directory at your wish - everything you need then is to fix a path to this directory in file that you copied at first step (index.cgi or index.fcgi, line 11).

4. Copy one of the config directory files into the htdocs (httpdocs, www or wwwroot) directory of your web server. Choose a file to copy according to file you copied at first step - if you want a CGI application - you will need to copy apache_cgi and if you want a FastCGI application - use apache_fcgi instead. After copying, rename this file to .htaccess.

5. Copy the entire img directory into the htdocs (httpdocs, www or wwwroot) directory of you web server.

SEE ALSO

Helix, Helix::Application

http://www.atma7.com/en/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

cpanm Helix

perl -MCPAN -e shell
install Helix