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 10> for 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<More Catalyst Basics|Catalyst::Manual::Tutorial::MoreCatalystBasics>
  25
  26 =item 4
  27
  28 L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>
  29
  30 =item 5
  31
  32 L<Authentication|Catalyst::Manual::Tutorial::Authentication>
  33
  34 =item 6
  35
  36 L<Authorization|Catalyst::Manual::Tutorial::Authorization>
  37
  38 =item 7
  39
  40 L<Debugging|Catalyst::Manual::Tutorial::Debugging>
  41
  42 =item 8
  43
  44 L<Testing|Catalyst::Manual::Tutorial::Testing>
  45
  46 =item 9
  47
  48 L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
  49
  50 =item 10
  51
  52 L<Appendices|Catalyst::Manual::Tutorial::Appendices>
  53
  54 =back
  55
  56
  57 =head1 DESCRIPTION
  58
  59 This tutorial provides a multipart introduction to the Catalyst web
  60 framework. It seeks to provide a rapid overview of many of its most
  61 commonly used features. The focus is on the real-world best practices
  62 required in the construction of nearly all Catalyst applications.
  63
  64 Although the primary target of the tutorial is users new to the Catalyst
  65 framework, experienced users may wish to review specific sections (for
  66 example, how to use DBIC for their model classes, how to add
  67 authentication and authorization to an existing application, or form
  68 management).
  69
  70 You can obtain the code for all the tutorial examples from the
  71 catalyst subversion repository by issuing the command:
  72
  73     svn co http://dev.catalyst.perl.org/repos/Catalyst/tags/examples/Tutorial/MyApp/5.7/ CatalystTutorial
  74
  75 This will download the current code for each tutorial chapter in the
  76 CatalystTutorial directory.  Each example application directory has
  77 the same name as the tutorial chapter.
  78
  79 B<These reference implementations are provided so that when you follow
  80 the tutorial, you can use the code from the subversion repository to
  81 ensure that your system is set up correctly, and that you have not
  82 inadvertently made any typographic errors, or accidentally skipped
  83 part of the tutorial.>
  84
  85 B<NOTE: You can use any perl-supported OS and environment to run
  86 Catalyst.> It should make little or no difference to Catalyst's
  87 operation, but this tutorial has been written using Ubuntu 8.10
  88 because that represents a quick and easy for most people to try out
  89 Catalyst with virtually zero setup time and hassles.  See the Catalyst
  90 installation section below for more information.
  91
  92 If you're reading this manual online, you can download the example
  93 program and all the necessary dependencies to your local machine by
  94 installing the C<Task::Catalyst::Tutorial> distribution from CPAN:
  95
  96      cpan Task::Catalyst::Tutorial
  97
  98 This will also test to make sure the dependencies are working.  If you
  99 have trouble installing these, please ask for help on the #catalyst
 100 IRC channel, or the Catalyst mailing list.
 101
 102 Subjects covered by the tutorial include:
 103
 104 =over 4
 105
 106 =item *
 107
 108 A simple application that lists and adds books.
 109
 110 =item *
 111
 112 The use of L<DBIx::Class|DBIx::Class> (DBIC) for the model.
 113
 114 =item *
 115
 116 How to write CRUD (Create, Read, Update, and Delete) operations in
 117 Catalyst.
 118
 119 =item *
 120
 121 Authentication ("auth").
 122
 123 =item *
 124
 125 Role-based authorization ("authz").
 126
 127 =item *
 128
 129 Attempts to provide an example showing current (5.7XXX) Catalyst
 130 practices. For example, the use of
 131 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView>,
 132 DBIC, L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
 133 with C<myapp.conf>, the use of C<lib/MyApp/Controller/Root.pm>
 134 vs. C<lib/MyApp.pm>, etc.
 135
 136 =item *
 137
 138 The use of Template Toolkit (TT) and the
 139 L<Catalyst::Helper::View::TTSite|Catalyst::Helper::View::TTSite>
 140 view helper.
 141
 142 =item *
 143
 144 Useful techniques for troubleshooting and debugging Catalyst
 145 applications.
 146
 147 =item *
 148
 149 The use of SQLite as a database (with code also provided for MySQL and
 150 PostgreSQL).
 151
 152 =item *
 153
 154 The use of L<HTML::FormFu|HTML::FormFu> for automated form processing
 155 and validation.
 156
 157 =back
 158
 159 This tutorial makes the learning process its main priority.  For
 160 example, the level of comments in the code found here would likely be
 161 considered excessive in a "normal project."  Because of their contextual
 162 value, this tutorial will generally favor inline comments over a
 163 separate discussion in the text.  It also deliberately tries to
 164 demonstrate multiple approaches to various features (in general, you
 165 should try to be as consistent as possible with your own production
 166 code).
 167
 168 Furthermore, this tutorial tries to minimize the number of controllers,
 169 models, TT templates, and database tables.  Although this does result in
 170 things being a bit contrived at times, the concepts should be applicable
 171 to more complex environments.  More complete and complicated example
 172 applications can be found in the C<examples> area of the Catalyst
 173 Subversion repository at
 174 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/>.
 175
 176 B<Note:> There are a variety of other introductory materials available
 177 through the Catalyst web site and at
 178 L<http://dev.catalyst.perl.org/wiki/UserIntroductions> and
 179 L<http://dev.catalyst.perl.org/>.
 180
 181 =head1 VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
 182
 183 This tutorial was built using the following resources. Please note that
 184 you may need to make adjustments for different environments and
 185 versions:
 186
 187 =over 4
 188
 189 =item *
 190
 191 Ubuntu 8.10 (Intrepid Ibex)
 192
 193 =item *
 194
 195 Catalyst v5.7014
 196
 197 =item *
 198
 199 Catalyst::Devel v1.07
 200
 201 =item *
 202
 203 DBIx::Class v0.08010
 204
 205 =item *
 206
 207 Catalyst Plugins
 208
 209 The plugins used in this tutorial all have sufficiently stable APIs that
 210 you shouldn't need to worry about versions. However, there could be
 211 cases where the tutorial is affected by what version of plugins you
 212 use. This tutorial has been tested against the following set of plugins:
 213
 214 =over 4
 215
 216 =item *
 217
 218 Catalyst::Plugin::Authentication -- v0.10006
 219
 220 =item *
 221
 222 Catalyst::Plugin::Authorization::ACL -- v0.08
 223
 224 =item *
 225
 226 Catalyst::Plugin::Authorization::Roles -- v0.05
 227
 228 =item *
 229
 230 Catalyst::Plugin::ConfigLoader -- v0.20
 231
 232 =item *
 233
 234 Catalyst::Plugin::Session -- v0.19
 235
 236 =item *
 237
 238 Catalyst::Plugin::Session::State::Cookie -- v0.09
 239
 240 =item *
 241
 242 Catalyst::Plugin::Session::Store::FastMmap -- v0.05
 243
 244 =item *
 245
 246 Catalyst::Plugin::StackTrace -- v0.08
 247
 248 =item *
 249
 250 Catalyst::Plugin::Static::Simple -- v0.20
 251
 252 =back
 253
 254 =item *
 255
 256 B<NOTE:> You can check the versions you have installed with the
 257 following command:
 258
 259     perl -ME<lt>mod_nameE<gt> -e '"print $E<lt>mod_nameE<gt>::VERSION\n"'
 260
 261 For example:
 262     perl -MCatalyst::Plugin::StackTrace -e 'print "$Catalyst::Plugin::StackTrace::VERSION\n"'
 263
 264 Since the web browser is being used on the same box where Perl and the
 265 Catalyst development server is running, the URL of
 266 C<http://localhost:3000> will be used (the Catalyst development server
 267 defaults to port 3000).  If you are running Perl on a different box than
 268 where your web browser is located (or using a different port number via
 269 the C<-p> I<port_number> option to the development server), then you
 270 will need to update the URL you use accordingly.
 271
 272 =item *
 273
 274 Depending on the web browser you are using, you might need to hit
 275 C<Shift+Reload> to pull a fresh page when testing your application at
 276 various points.  Also, the C<-k> keepalive option to the development
 277 server can be necessary with some browsers (especially Internet
 278 Explorer).
 279
 280 =back
 281
 282 =head1 CATALYST INSTALLATION
 283
 284 While the rough edges of Catalyst installation have been a problem in
 285 the past, this is now mostly solved.  Nonetheless, installing Catalyst
 286 can be a little time consuming. Although a compelling strength of
 287 Catalyst is that it makes use of many of the modules in the vast
 288 repository that is CPAN, this can complicate the installation process.
 289 However, there are a growing number of methods that can dramatically
 290 ease this undertaking.  Of these, the following are likely to be
 291 applicable to the largest number of potential new users:
 292
 293 =over 4
 294
 295 =item *
 296
 297 Ubuntu
 298
 299 Given the popularity of Ubuntu and its ease of use, Ubuntu can be
 300 a great way for newcomers to experiment with Catalyst.  Because it
 301 is a "live CD," you can simply boot from the CD, run a few commands,
 302 and you should have a fully functional environment in which to do
 303 this tutorial in a matter of minutes.
 304
 305 =over 4
 306
 307 =item *
 308
 309 Download Ubuntu 8.10 (aka, Intrepid Ibex) Desktop edition and boot from
 310 the CD and/or image file, select your language, and then "Try Ubuntu
 311 without any changes to your computer."
 312
 313 =item *
 314
 315 Open a terminal session (click "Applications" in the upper-left
 316 corner, then "Accessories," then "Terminal").
 317
 318 =item *
 319
 320 Add the 'universe' repositories:
 321
 322     sudo gedit /etc/apt/sources.list
 323
 324 And remove the comments from the lines under the comments about the
 325 'universe' repositories.
 326
 327 =item *
 328
 329 Install Catalyst:
 330
 331     sudo apt-get update
 332     sudo apt-get install libdbd-sqlite3-perl libcatalyst-perl libcatalyst-modules-perl libconfig-general-perl
 333
 334 Accept all of the dependencies.  Done.
 335
 336 NOTE: If you are low on disk space after the above commands (use C<df />
 337 to tell), you can free up some space with
 338 C<sudo rm /var/cache/apt/archives/*.deb> (the Live CD uses memory for
 339 disk space, so having a decent amount of memory will help).  And,
 340 while the instructions above mention the Live CD because that makes it
 341 easy for people new to Linux, you can obviously also use one of the
 342 options to install Ubuntu on your drive.
 343
 344 =back
 345
 346 =item *
 347
 348 Matt Trout's C<cat-install>
 349
 350 Available at L<http://www.shadowcatsystems.co.uk/static/cat-install>,
 351 C<cat-install> can be a quick and painless way to get Catalyst up and
 352 running.  Just download the script from the link above and type C<perl
 353 cat-install>.
 354
 355 =item *
 356
 357 Chris Laco's CatInABox
 358
 359 Download the tarball from
 360 L<http://handelframework.com/downloads/CatInABox.tar.gz> and unpack it
 361 on your machine.  Depending on your OS platform, either run C<start.bat>
 362 or C<start.sh>.
 363
 364 =item *
 365
 366 Pre-Built VMWare Images
 367
 368 Under the VMWare community program, work is ongoing to develop a number
 369 of VMWare images where an entire Catalyst development environment has
 370 already been installed, complete with database engines and a full
 371 complement of Catalyst plugins.
 372
 373 =item *
 374
 375 Frank Speiser's Amazon EC2 Catalyst SDK
 376
 377 There are currently two flavors of publicly available Amazon Machine
 378 Images (AMI) that include all the elements you'd need to begin
 379 developing in a fully functional Catalyst environment within minutes.
 380 See L<Catalyst::Manual::Installation|Catalyst::Manual::Installation>
 381 for more details.
 382
 383 =back
 384
 385 For additional information and recommendations on Catalyst installation,
 386 please refer to
 387 L<Catalyst::Manual::Installation|Catalyst::Manual::Installation>.
 388
 389 B<NOTE:> Step-by-step instructions to replicate the environment on
 390 which this tutorial was developed can be found at
 391 L<Catalyst::Manual::Installation::CentOS4|Catalyst::Manual::Installation::CentOS4>.
 392 Using these instructions, you should be able to build a complete CentOS
 393 4.X server with Catalyst and all the plugins required to run this
 394 tutorial.
 395
 396 =head1 DATABASES
 397
 398 This tutorial will primarily focus on SQLite because of its simplicity
 399 of installation and use; however, modifications in the script required
 400 to support MySQL and PostgreSQL will be presented in Appendix 2.
 401
 402 B<Note:> One of the advantages of the MVC design patterns is that
 403 applications become much more database independent.  As such, you will
 404 notice that only the C<.sql> files used to initialize the database
 405 change between database systems: the Catalyst code generally remains the
 406 same.
 407
 408 =head1 WHERE TO GET WORKING CODE
 409
 410 Each part of the tutorial has complete code available in the main
 411 Catalyst Subversion repository (see the note at the beginning of each
 412 part for the appropriate svn command to use).  Additionally, the final
 413 code is available as a ready-to-run tarball at
 414 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz>.
 415
 416 B<NOTE:> You can run the test cases for the final code with the following
 417 commands:
 418
 419     wget http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz
 420     tar zxvf MyApp.tgz
 421     cd MyApp
 422     CATALYST_DEBUG=0 prove --lib lib  t
 423
 424
 425 =head1 AUTHOR
 426
 427 Kennedy Clark, C<hkclark@gmail.com>
 428
 429 Please report any errors, issues or suggestions to the author.  The
 430 most recent version of the Catalyst Tutorial can be found at
 431 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Manual/lib/Catalyst/Manual/Tutorial/>.
 432
 433 Copyright 2006-2008, Kennedy Clark, under Creative Commons License
 434 (L<http://creativecommons.org/licenses/by-sa/3.0/us/>).