lib/Catalyst/Manual/Tutorial/Intro.pod

   1 =head1 NAME
   2
   3 Catalyst::Manual::Tutorial::Intro - Catalyst Tutorial - Part 1: Introduction
   4
   5
   6 =head1 OVERVIEW
   7
   8 This is B<Part 1 of 9> of the Catalyst Tutorial.
   9
  10 L<Tutorial Overview|Catalyst::Manual::Tutorial>
  11
  12 =over 4
  13
  14 =item 1
  15
  16 B<Introduction>
  17
  18 =item 2
  19
  20 L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>
  21
  22 =item 3
  23
  24 L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>
  25
  26 =item 4
  27
  28 L<Authentication|Catalyst::Manual::Tutorial::Authentication>
  29
  30 =item 5
  31
  32 L<Authorization|Catalyst::Manual::Tutorial::Authorization>
  33
  34 =item 6
  35
  36 L<Debugging|Catalyst::Manual::Tutorial::Debugging>
  37
  38 =item 7
  39
  40 L<Testing|Catalyst::Manual::Tutorial::Testing>
  41
  42 =item 8
  43
  44 L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
  45
  46 =item 9
  47
  48 L<Appendices|Catalyst::Manual::Tutorial::Appendices>
  49
  50 =back
  51
  52 =head1 DESCRIPTION
  53
  54 This tutorial provides a multipart introduction to the Catalyst web
  55 framework. It seeks to provide a rapid overview of many of its most
  56 commonly used features. The focus is on the real-world best practices
  57 required in the construction of nearly all Catalyst applications.
  58
  59 Although the primary target of the tutorial is users new to the Catalyst
  60 framework, experienced users may wish to review specific sections (for
  61 example, how to use DBIC for their model classes or how to add
  62 authentication and authorization to an existing application).
  63
  64 Subjects covered include:
  65
  66 =over 4
  67
  68 =item *
  69
  70 A simple application that lists and adds books.
  71
  72 =item *
  73
  74 The use of L<DBIx::Class|DBIx::Class> (DBIC) for the model.
  75
  76 =item *
  77
  78 How to write CRUD (Create, Read, Update, and Delete) operations in
  79 Catalyst.
  80
  81 =item *
  82
  83 Authentication ("auth").
  84
  85 =item *
  86
  87 Role-based authorization ("authz").
  88
  89 =item *
  90
  91 Attempts to provide an example showing current (5.7000) Catalyst
  92 practices. For example, the use of
  93 L<Catalyst::Plugin::DefaultEnd|Catalyst::Plugin::DefaultEnd>,
  94 DBIC, L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
  95 with C<myapp.yml>, the use of C<lib/MyApp/Controller/Root.pm>
  96 vs. C<lib/MyApp.pm>, etc.
  97
  98 =item *
  99
 100 The use of Template Toolkit (TT) and the
 101 L<Catalyst::Helper::View::TTSite|Catalyst::Helper::View::TTSite>
 102 view helper.
 103
 104 =item *
 105
 106 Useful techniques for troubleshooting and debugging Catalyst
 107 applications.
 108
 109 =item *
 110
 111 The use of SQLite as a database (with code also provided for MySQL and
 112 PostgreSQL).
 113
 114 =item *
 115
 116 The use of L<HTML::Widget|HTML::Widget> for automated form processing
 117 and validation.
 118
 119 =back
 120
 121 This tutorial makes the learning process its main priority.  For
 122 example, the level of comments in the code found here would like be
 123 considered excessive in a "normal project".  Because of their contextual
 124 value, this tutorial will generally favor inline comments over a
 125 separate discussion in the text.  It also deliberately tries to
 126 demonstrate multiple approaches to various features (in general, you
 127 should try to be as consistent as possible with your own production
 128 code).
 129
 130 Furthermore, this tutorial tries to minimize the number of controllers,
 131 models, TT templates, and database tables.  Although this does result in
 132 things being a bit contrived at times, the concepts should be applicable
 133 to more complex environments.  More complete and complicated example
 134 applications can be found in the C<examples> area of the Catalyst
 135 Subversion repository at
 136 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/>.
 137
 138 B<Note:> There are a variety of other introductory materials available
 139 through the Catalyst web site and at
 140 L<http://dev.catalyst.perl.org/wiki/UserIntroductions> and
 141 L<http://dev.catalyst.perl.org/>.
 142
 143 =head1 VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
 144
 145 This tutorial was built using the following resources. Please note that
 146 you may need to make adjustments for different environments and
 147 versions:
 148
 149 =over 4
 150
 151 =item *
 152
 153 OS = CentOS 4 Linux (RHEL 4)
 154
 155 =item *
 156
 157 Catalyst v5.6902
 158
 159 =item *
 160
 161 DBIx::Class v0.06003
 162
 163 =item *
 164
 165 Catalyst Plugins
 166
 167 The plugins used in this tutorial all have sufficiently stable APIs that
 168 you shouldn't need to worry about versions. However, there could be
 169 cases where the tutorial is affected by what version of plugins you
 170 use. The plugins used for this tutorial are:
 171
 172 =over 4
 173
 174 =item *
 175
 176 Catalyst::Plugin::Authentication -- 0.07
 177
 178 =item *
 179
 180 Catalyst::Plugin::Authentication::Credential::Password -- 0.07
 181
 182 =item *
 183
 184 Catalyst::Plugin::Authentication::Store::DBIC -- 0.06
 185
 186 =item *
 187
 188 Catalyst::Plugin::Authorization::ACL -- 0.06
 189
 190 =item *
 191
 192 Catalyst::Plugin::Authorization::Roles -- 0.04
 193
 194 =item *
 195
 196 Catalyst::Plugin::ConfigLoader -- 0.07
 197
 198 =item *
 199
 200 Catalyst::Plugin::DefaultEnd -- 0.06
 201
 202 =item *
 203
 204 Catalyst::Plugin::HTML::Widget -- 1.1
 205
 206 =item *
 207
 208 Catalyst::Plugin::Session -- 0.05
 209
 210 =item *
 211
 212 Catalyst::Plugin::Session::FastMmap -- 0.12
 213
 214 =item *
 215
 216 Catalyst::Plugin::Session::State::Cookie -- 0.02
 217
 218 =item *
 219
 220 Catalyst::Plugin::Session::Store::FastMmap -- 0.02
 221
 222 =item *
 223
 224 Catalyst::Plugin::StackTrace -- 0.04
 225
 226 =item *
 227
 228 Catalyst::Plugin::Static::Simple -- 0.14
 229
 230 =back
 231
 232 =item *
 233
 234 Since the web browser is being used on the same box where Perl and the
 235 Catalyst development server is running, the URL of
 236 C<http://localhost:3000> will be used (the Catalyst development server
 237 defaults to port 3000).  If you are running Perl on a different box than
 238 where your web browser is located (or using a different port number via
 239 the C<-p> I<port_number> option to the development server), then you
 240 will need to update the URL you use accordingly.
 241
 242 =item *
 243
 244 Depending on the web browser you are using, you might need to hit
 245 C<Shift+Reload> to pull a fresh page when testing your application at
 246 various points.  Also, the C<-k> keepalive option to the development
 247 server can be necessary with some browsers (especially Internet
 248 Explorer).
 249
 250 =back
 251
 252 =head1 CATALYST INSTALLATION
 253
 254 Unfortunately, one of the most daunting tasks faced by newcomers to
 255 Catalyst is getting it installed.  Although a compelling strength of
 256 Catalyst is that it can easily make use of many of the modules in the
 257 vast repository that is CPAN, this can result in initial installations
 258 that are both time consuming and frustrating.  However, there are a
 259 growing number of methods that can dramatically ease this undertaking.
 260 Of these, the following are likely to be applicable to the largest
 261 number of potential new users:
 262
 263 =over 4
 264
 265 =item *
 266
 267 Matt Trout's C<cat-install>
 268
 269 Available at L<http://www.shadowcatsystems.co.uk/static/cat-install>,
 270 C<cat-install> can be a quick and painless way to get Catalyst up and
 271 running.  Just download the script from the link above and type C<perl
 272 cat-install>.
 273
 274 =item *
 275
 276 Chris Laco's CatInABox
 277
 278 Download the tarball from
 279 L<http://handelframework.com/downloads/CatInABox.tar.gz> and unpack it
 280 on your machine.  Depending on your OS platform, either run C<start.bat>
 281 or C<start.sh>.
 282
 283 =item *
 284
 285 Pre-Built VMWare Images
 286
 287 Under the VMWare community program, work is ongoing to develop a number
 288 of VMWare images where an entire Catalyst development environment has
 289 already been installed, complete with database engines and a full
 290 complement of Catalyst plugins.
 291
 292 =back
 293
 294 For additional information and recommendations on Catalyst installation,
 295 please refer to
 296 L<Catalyst::Manual::Installation|Catalyst::Manual::Installation>.
 297
 298 B<NOTE:> Step-by-step instructions to replicate the environment on
 299 which this tutorial was developed can be found at
 300 L<Catalyst::Manual::Installation::CentOS4|Catalyst::Manual::Installation::CentOS4>.
 301 Using these instructions, you should be able to build a complete CentOS
 302 4.X server with Catalyst and all the plugins required to run this
 303 tutorial.
 304
 305 =head1 DATABASES
 306
 307 This tutorial will primarily focus on SQLite because of its simplicity
 308 of installation and use; however, modifications in the script required
 309 to support MySQL and PostgreSQL will be presented in Appendix 2.
 310
 311 B<Note:> One of the advantages of the MVC design patterns is that
 312 applications become much more database independent.  As such, you will
 313 notice that only the C<.sql> files used to initialize the database
 314 change between database systems: the Catalyst code generally remains the
 315 same.
 316
 317 =head1 WHERE TO GET WORKING CODE
 318
 319 Each part of the tutorial has complete code available in the main
 320 Catalyst Subversion repository (see the note at the beginning of each
 321 part for the appropriate svn command to use).  Additionally, the final
 322 code is available as a ready-to-run tarball at
 323 I<TO_BE_ADDED_TO_FINAL_VERSION>.
 324
 325
 326 =head1 AUTHOR
 327
 328 Kennedy Clark, C<hkclark@gmail.com>
 329
 330 Please report any errors, issues or suggestions to the author.  The
 331 most recent version of the Catlayst Tutorial can be found at
 332 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Runtime/lib/Catalyst/Manual/Tutorial/>.
 333
 334 Copyright 2006, Kennedy Clark, under Creative Commons License
 335 (L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).
 336
 337