CodeKit Perl Source Code Setup

Read the Overview and the Code Table Setup pages first.

Load and test the ck_code table schema definition as well as the core data records. The proceed with the source code setup and testing.

The CodeKit Perl source code is in the perl directory:

    CodeKit.pm        - CodeKit module definition.
    ck_admin.pl       - Setup for ck_admin_main.pl.
    ck_admin_main.pl  - CodeKit Translation Utility.
    ck_connect.pl     - Database connection setup.
    ck_demo.pl        - CodeKit Demo page.
    t/test.t          - Regression testing.
    Makefile.PL       - Makefile setup.
CodeKit.pm requires the DBI.pm module. The Translation Utility and the Demo page need the CGI.pm module.

Database Connection Setup

You can customize the ck_connect.pl file to open a database handle to your database. If your application setup has already opened a database handle, use that handle instead of opening a new one.

ck_connect.pl is used by ck_admin.pl, ck_demo.pl and by t/test.t.

CodeKit.pm Setup

Copy the CodeKit.pm file into a directory on your Perl include path. Or do the makefile thing:
    $ perl Makefile.PL
    $ make
    $ make test
    # make install

CodeKit Regression Test

Once the code table is set up and loaded and ck_connect.pl is set up run the regression tests on the basic CodeKit module functions:
    $ make test

CodeKit Administration Page Setup

Customize the ck_admin.pl file to your situation:
  • Require and open a CodeKit handle.
  • Set the $perm_add, $perm_upd and $perm_del global variables. These let the user add, update and delete codes.
  • Define the cka_sess_url() function. Customize this if you are carrying session identifiers in your urls.
  • Require ck_admin_main.pl and call the cka_admin_main() function.

Demo Page Setup

In order for the demo page to function, you will need to load the demo data records.