.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Bigtop::Docs::QuickStart 3"
.TH Bigtop::Docs::QuickStart 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "Name"
.IX Header "Name"
Bigtop::Docs::QuickStart \- The fastest ways to Gantry apps with Bigtop
.SH "From the Command Line Alone"
.IX Header "From the Command Line Alone"
Suppose you want to keep track of your relatives phone numbers and
their children's birthdays.  After installing sqlite, Gantry, and Bigtop,
type:
.PP
.Vb 3
\&    bigtop -n Phone 'family(name,phone,+email)<-child(name,birth_day:date)'
\&    cd Phone
\&    ./app.server
.Ve
.PP
We call the definition in the single quotes the 'kickstart,' it's a
description of the data model.  See Bigtop::ScriptHelp::Style::Kickstart
for additional details on the syntax for kickstarts.  Here there are two
tables.  family has name, phone, and optional email columns.  child has
name and birth_day which is a date.
.PP
If you don't have sqlite, you'll need to build your database.  If your
database engine of choice is PostgreSQL or MySQL, you can follow these
instructions...
.Sh "PostgreSQL"
.IX Subsection "PostgreSQL"
.Vb 4
\&    cd Phone
\&    createdb app.db -U some_power_user
\&    psql app.db -U regular_user < docs/schema.postgres
\&    ./app.server -d Pg -u regular_user -p password
.Ve
.Sh "mysql"
.IX Subsection "mysql"
.Vb 4
\&    cd Phone
\&    msyqladmin create app.db -u root -p
\&    mysql -u regular_user -p app.db < docs/schema.mysql
\&    ./app.server -d mysql -u regular_user -p password
.Ve
.PP
In all cases, once you start \f(CW\*(C`app.server\*(C'\fR, it will print URLs where you
may point your browser to start using the app.
.PP
You may choose to put the database connection information in the base config
block in your bigtop file.  Then you won't need the flags.  If you want
to use mulitple databases on a regular basis, consider adding a config block
named for each database:
.PP
.Vb 5
\&    config mydbd {
\&        dbconn `dbi:mydbd:dbname=somename`;
\&        dbuser `your_pg_user`;
\&        dbpass `secret`;
\&    }
.Ve
.PP
Then you can regenerate once, and switch to the database of your choice with
one command line flag:
.PP
.Vb 2
\&    bigtop docs/your.bigtop  # do this once
\&    ./app.server -t mydbd    # repeat on each server start
.Ve
.PP
The rest of your app's config info will still come from the base config block,
which you don't need to change.
.SH "From a PostgreSQL Database"
.IX Header "From a PostgreSQL Database"
If you already have a PostgreSQL 8 database called yourdb, and would like a
\&\s-1CRUD\s0 app for it:
.PP
.Vb 3
\&    bigtop -n YourApp -s Pg8Live 'dbi:Pg:dbname=yourdb' user pass
\&    cd YourApp
\&    ./app.server -d Pg -n yourdb -u user -p pass
.Ve
.PP
Again, you might want to create a config block for this database as
discussed above.