=head1 DESCRIPTION
-This tutorial provides a multipart introduction to the Catalyst web
+This tutorial provides a multi-part introduction to the Catalyst web
framework. It seeks to provide a rapid overview of many of its most
commonly used features. The focus is on the real-world best practices
required in the construction of nearly all Catalyst applications.
You can obtain the code for all the tutorial examples from the
catalyst subversion repository by issuing the command:
- svn co http://dev.catalyst.perl.org/repos/Catalyst/tags/examples/Tutorial/MyApp/5.7/ CatalystTutorial
+ svn co http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/ CatalystTutorial
-This will download the current code for each tutorial chapter in the
-CatalystTutorial directory. Each example application directory has
-the same name as the tutorial chapter.
+This will download the most recent tarball for each part of the
+tutorial into the CatalystTutorial directory on your machine.
B<These reference implementations are provided so that when you follow
the tutorial, you can use the code from the subversion repository to
inadvertently made any typographic errors, or accidentally skipped
part of the tutorial.>
-B<NOTE: You can use any perl-supported OS and environment to run
+B<NOTE: You can use any Perl-supported OS and environment to run
Catalyst.> It should make little or no difference to Catalyst's
-operation, but this tutorial has been written using Ubuntu 8.10
+operation, B<but this tutorial has been written using Ubuntu 8.10>
because that represents a quick and easy for most people to try out
-Catalyst with virtually zero setup time and hassles. See the Catalyst
-installation section below for more information.
+Catalyst with virtually zero setup time and hassles. Also, the tutorial
+has been tested to work correctly with the versions of Catalyst and all
+the supporting modules in Ubuntu 8.10 (see "VERSIONS AND CONVENTIONS
+USED IN THIS TUTORIAL" below for the specific versions for some of the
+key modules), so B<if you think you might be running into an issue
+related to versions> (for example, a module changed its behavior in a
+newer version or a bug was introduced), B<it might be worth giving
+Ubuntu 8.10 a try>. See the "CATALYST INSTALLATION" section below for
+more information.
If you're reading this manual online, you can download the example
program and all the necessary dependencies to your local machine by
Subversion repository at
L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/>.
-B<Note:> There are a variety of other introductory materials available
-through the Catalyst web site and at
-L<http://dev.catalyst.perl.org/wiki/UserIntroductions> and
-L<http://dev.catalyst.perl.org/>.
-
=head1 VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
Ubuntu
-Given the popularity of Ubuntu and its ease of use, Ubuntu can be
-a great way for newcomers to experiment with Catalyst. Because it
-is a "live CD," you can simply boot from the CD, run a few commands,
-and you should have a fully functional environment in which to do
-this tutorial in a matter of minutes.
+Given the popularity of Ubuntu and its ease of use, Ubuntu can be a
+great way for newcomers to experiment with Catalyst. Because it is a
+"live CD," you can simply boot from the CD, run a few commands, and you
+should have a fully functional environment in which to do this tutorial
+in a matter of minutes. B<The tutorial was fully tested to work under
+Ubuntu 8.10. Although it SHOULD work under any Catalyst installation
+method you might choose, it can be hard to guarantee this.>
=over 4
sudo apt-get update
sudo apt-get install libdbd-sqlite3-perl libcatalyst-perl libcatalyst-modules-perl libconfig-general-perl
-Accept all of the dependencies. Done.
+Accept all of the dependencies. Done.
+
+If you are running from the Live CD, you probably also want to free up
+some disk space with the following:
+
+ sudo apt-get clean
-NOTE: If you are low on disk space after the above commands (use C<df />
-to tell), you can free up some space with
-C<sudo rm /var/cache/apt/archives/*.deb> (the Live CD uses memory for
-disk space, so having a decent amount of memory will help). And,
-while the instructions above mention the Live CD because that makes it
-easy for people new to Linux, you can obviously also use one of the
-options to install Ubuntu on your drive.
+NOTE: While the instructions above mention the Live CD because that
+makes it easy for people new to Linux, you can obviously also use one
+of the options to install Ubuntu on your drive.
=back
Matt Trout's C<cat-install>
-Available at L<http://www.shadowcatsystems.co.uk/static/cat-install>,
-C<cat-install> can be a quick and painless way to get Catalyst up and
-running. Just download the script from the link above and type C<perl
-cat-install>.
+Available at L<http://www.shadowcatsystems.co.uk/static/cat-install>,
+C<cat-install> can be a fairly painless way to get Catalyst up and
+running. Just download the script from the link above and type C<perl
+cat-install>. Depending on the speed of your Internet connection and
+your computer, it will probably take 30 to 60 minutes to install because
+it downloads, makes, compiles, and tests every module. But this is an
+excellent way to automate the installation of all the latest modules
+used by Catalyst from CPAN.
+
=item *
-Chris Laco's CatInABox
+Other Possibilities
+
+=over 4
+
+=item *
+
+OpenBSD Packages
+
+The 2008 Advent Day 4 entry has more information on using OpenBSD
+packages to quickly build a system:
+L<http://www.catalystframework.org/calendar/2008/4>.
-Download the tarball from
-L<http://handelframework.com/downloads/CatInABox.tar.gz> and unpack it
-on your machine. Depending on your OS platform, either run C<start.bat>
-or C<start.sh>.
+=item *
+
+NetBSD Package Collection on Solaris
+
+The 2008 Advent Day 15 entry has more information on using C<pkgsrc> and
+NetBSD packages on Solaris:
+L<http://www.catalystframework.org/calendar/2008/15|>.
=item *
+CatInABox
+
+You can get more information at
+L<http://www.catalystframework.org/calendar/2008/7>
+or L<Perl::Dist::CatInABox|Perl::Dist::CatInABox>.
+
+
+=item *
+
Pre-Built VMWare Images
Under the VMWare community program, work is ongoing to develop a number
=back
+=back
+
For additional information and recommendations on Catalyst installation,
please refer to
L<Catalyst::Manual::Installation|Catalyst::Manual::Installation>.
=head1 WHERE TO GET WORKING CODE
-Each part of the tutorial has complete code available in the main
-Catalyst Subversion repository (see the note at the beginning of each
-part for the appropriate svn command to use). Additionally, the final
-code is available as a ready-to-run tarball at
-L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz>.
+Each part of the tutorial has complete code available as a tarball in
+the main Catalyst Subversion repository (see the note at the beginning
+of each part for the appropriate svn command to use).
-B<NOTE:> You can run the test cases for the final code with the following
-commands:
+B<NOTE:> You can run the test cases for the final code through Part 8
+with the following commands:
- wget http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz
- tar zxvf MyApp.tgz
+ wget http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/MyApp_Part8.tgz
+ tar zxvf MyApp_Part8.tgz
cd MyApp
CATALYST_DEBUG=0 prove --lib lib t
projects / catagits/Catalyst-Manual.git / blobdiff