3 Catalyst::Manual::Tutorial::Intro - Catalyst Tutorial - Part 1: Introduction
8 This is B<Part 1 of 9> of the Catalyst Tutorial.
10 L<Tutorial Overview|Catalyst::Manual::Tutorial>
20 L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>
24 L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>
28 L<Authentication|Catalyst::Manual::Tutorial::Authentication>
32 L<Authorization|Catalyst::Manual::Tutorial::Authorization>
36 L<Debugging|Catalyst::Manual::Tutorial::Debugging>
40 L<Testing|Catalyst::Manual::Tutorial::Testing>
44 L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
48 L<Appendices|Catalyst::Manual::Tutorial::Appendices>
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.
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).
64 Subjects covered include:
70 A simple application that lists and adds books.
74 The use of L<DBIx::Class|DBIx::Class> (DBIC) for the model.
78 How to write CRUD (Create, Read, Update, and Delete) operations in
83 Authentication ("auth").
87 Role-based authorization ("authz").
91 Attempts to provide an example showing current (5.70) 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.
100 The use of Template Toolkit (TT) and the
101 L<Catalyst::Helper::View::TTSite|Catalyst::Helper::View::TTSite>
106 Useful techniques for troubleshooting and debugging Catalyst
111 The use of SQLite as a database (with code also provided for MySQL and
116 The use of HTML::Widget for automated form processing and validation.
120 This tutorial makes the learning process its main priority. For
121 example, the level of comments in the code found here would like be
122 considered excessive in a "normal project". Because of their contextual
123 value, this tutorial will generally favor inline comments over a
124 separate discussion in the text. It also deliberately tries to
125 demonstrate multiple approaches to various features (in general, you
126 should try to be as consistent as possible with your own production
129 Furthermore, this tutorial tries to minimize the number of controllers,
130 models, TT templates, and database tables. Although this does result in
131 things being a bit contrived at times, the concepts should be applicable
132 to more complex environments. More complete and complicated example
133 applications can be found in the C<examples> area of the Catalyst
134 Subversion repository at
135 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/>.
137 B<Note:> There are a variety of other introductory materials available
138 through the Catalyst web site and at
139 L<http://dev.catalyst.perl.org/wiki/UserIntroductions> and
140 L<http://dev.catalyst.perl.org/>.
142 =head1 VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
144 This tutorial was built using the following resources. Please note that
145 you may need to make adjustments for different environments and
152 OS = CentOS 4 Linux (RHEL 4)
166 The plugins used in this tutorial all have sufficiently stable APIs that
167 you shouldn't need to worry about versions. However, there could be
168 cases where the tutorial is affected by what version of plugins you
169 use. The plugins used for this tutorial are:
175 Catalyst::Plugin::Authentication -- 0.07
179 Authentication::Credential::Password -- 0.07
183 Catalyst::Plugin::Authentication::Store::DBIC -- 0.06
187 Catalyst::Plugin::Authorization::ACL -- 0.06
191 Catalyst::Plugin::Authorization::Roles -- 0.04
195 Catalyst::Plugin::ConfigLoader -- 0.07
199 Catalyst::Plugin::DefaultEnd -- 0.06
203 Catalyst::Plugin::HTML::Widget -- 1.1
207 Catalyst::Plugin::Session -- 0.05
211 Catalyst::Plugin::Session::FastMmap -- 0.12
215 Catalyst::Plugin::Session::State::Cookie -- 0.02
219 Catalyst::Plugin::Session::Store::FastMmap -- 0.02
223 Catalyst::Plugin::StackTrace -- 0.04
227 Catalyst::Plugin::Static::Simple -- 0.14
233 Since the web browser is being used on the same box where Perl and the
234 Catalyst development server is running, the URL of
235 C<http://localhost:3000> will be used (the Catalyst development server
236 defaults to port 3000). If you are running Perl on a different box than
237 where your web browser is located (or using a different port number via
238 the C<-p> I<port_number> option to the development server), then you
239 will need to update the URL you use accordingly.
243 Depending on the web browser you are using, you might need to hit
244 C<Shift+Reload> to pull a fresh page when testing your application at
245 various points. Also, the C<-k> keepalive option to the development
246 server can be necessary with some browsers (especially Internet
251 =head1 CATALYST INSTALLATION
253 Unfortunately, one of the most daunting tasks faced by newcomers to
254 Catalyst is getting it installed. Although a compelling strength of
255 Catalyst is that it can easily make use of many of the modules in the
256 vast repository that is CPAN, this can result in initial installations
257 that are both time consuming and frustrating. However, there are a
258 growing number of methods that can dramatically ease this undertaking.
259 Of these, the following are likely to be applicable to the largest
260 number of potential new users:
266 Matt Trout's C<cat-install>
268 Available at L<http://www.shadowcatsystems.co.uk/static/cat-install>,
269 C<cat-install> can be a quick and painless way to get Catalyst up and
270 running. Just download the script from the link above and type C<perl
275 Chris Laco's CatInABox
277 Download the tarball from
278 L<http://handelframework.com/downloads/CatInABox.tar.gz> and unpack it
279 on your machine. Depending on your OS platform, either run C<start.bat>
284 Pre-Built VMWare Images
286 Under the VMWare community program, work is ongoing to develop a number
287 of VMWare images where an entire Catalyst development environment has
288 already been installed, complete with database engines and a full
289 complement of Catalyst plugins.
293 For additional information and recommendations on Catalyst installation,
295 L<Catalyst::Manual::Installation|Catalyst::Manual::Installation>.
297 B<NOTE:> Step-by-step instructions to replicate the environment on
298 which this tutorial was developed can be found at
299 L<Catalyst::Manual::Installation::CentOS4|Catalyst::Manual::Installation::CentOS4>.
300 Using these instructions, you should be able to build a complete CentOS
301 4.X server with Catalyst and all the plugins required to run this
306 This tutorial will primarily focus on SQLite because of its simplicity
307 of installation and use; however, modifications in the script required
308 to support MySQL and PostgreSQL will be presented in Appendix 2.
310 B<Note:> One of the advantages of the MVC design patterns is that
311 applications become much more database independent. As such, you will
312 notice that only the C<.sql> files used to initialize the database
313 change between database systems: the Catalyst code generally remains the
316 =head1 WHERE TO GET WORKING CODE
318 Each part of the tutorial has complete code available in the main
319 Catalyst Subversion repository (see the note at the beginning of each
320 part for the appropriate svn command to use). Additionally, the final
321 code is available as a ready-to-run tarball at
322 I<TO_BE_ADDED_TO_FINAL_VERSION>.
326 Kennedy Clark, C<hkclark@gmail.com>
328 Please report any errors, issues or suggestions to the author.
330 Copyright 2006, Kennedy Clark, under Creative Commons License
331 (L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).