/ 
Leyland-1.000001
River stage zero No dependents
/ Leyland::Manual

NAME

Leyland::Manual - Manual for the Leyland web application framework

VERSION

version 1.000001

WHAT IS LEYLAND

This section is just a copy of L<Leyland/"DESCRIPTION">.

Leyland is a Plack-based application framework for building truely RESTful, MVC-style web applications. It is feature rich and highly extensible.

FEATURES

  • Build truely RESTful web applications: Leyland was designed from the ground up according to the Representational State Transfer style of software architecture. Leyland applications perform real HTTP negotiations, (can) provide different representations of the same resource easily, respond with proper HTTP status codes, throw real HTTP exceptions, etc.

  • Automatic data (de)serialization - Leyland automatically serializes resources to representations in the format your client wants to receive, like JSON and XML. It will also automatically deserialize JSON/XML requests coming from the client to Perl data-structures.

  • Pure UTF-8 - Leyland applications are pure UTF-8. Anything your application receives is automatically UTF-8 decoded, and anything your application sends is automatically UTF-8 encoded. Leyland apps will not accept, nor provide, content in a different character set. If you want to use different/multiple encodings, then Leyland is not for you.

  • Localize for the client, not the server - Pretty much every other application framework only concerns itself with localizing the application to the locale of the machine on which it is running. I find that this is rarely useful nor interesting to the application developer. Leyland localizes for the client, not the server. If the client wants to view your application (which may be a simple website) in Hebrew, and your application supports Hebrew, then you can easily provide him with Hebrew representations. Leyland uses Locale::Wolowitz for this purpose.

  • Easy deployment and middleware support via Plack - Leyland doesn't support Plack, it is dependant on it. Leyland's entire session support, for example, depends on Plack's Session middleware. Use the full power of Plack in your Leyland application.

  • Lightweight - Leyland is much smaller than Catalyst or other major frameworks, while still providing lots of features. While it is not a "micro-framework", it is pretty small. If you're looking for an extremely lightweight solution, my other framework - McBain - might fit your need.

  • Flexible, extensible - Leyland was designed to be as flexible and as extensible as possible - where flexibility matters, and strict - where constistency and convention are appropriate. Leyland goes to great lengths to give you the ability to do things the way you want to, and more importantly - the way your end-users want to. Your applications listen to your users' preferences and automatically decide on a suitable course of action. Leyland is also Moo based, making it easy to extend and tweak its behavior (and making it Moose compatible).

  • Doesn't have a pony - You don't really need a pony, do you?

WHAT IS THIS MANUAL

This manual is your guide to creating Leyland-based web applications. Hopefully, it will provide you with all the knowledge you need to create Leyland applications and utilize its full potential.

TABLE OF CONTENTS

The guide is divided into the following sections (order purely a suggestion, but you probably should read Leyland::Manual::Applications first):

1. Leyland::Manual::Applications - Describes Leyland application structure and how to create (more correctly initialize) and configure Leyland applications.
2. Leyland::Manual::Controllers - Describes controllers, routes, resources, representations, etc.
3. Leyland::Manual::Views - Describes view classes and their usage.
4. Leyland::Manual::Models - Describes models and their usage.
5. Leyland::Manual::StaticFiles - Describes how to serve static files from your application.
6. Leyland::Manual::Localization - Describes how application localization is performed.
7. Leyland::Manual::Logging - Describes how to use Leyland's logging facilities.
8. Leyland::Manual::Exceptions - To err is human, to throw proper HTTP exceptions divine.
9. Leyland::Manual::Deployment - Describes how to run/deploy/test Leyland applications.
10. Leyland::Manual::Extending - Describes how to extend Leyland.
11. Leyland::Manual::FAQ - Contains frequently asked questions and their answers.
12. Leyland::Manual::Upgrading - Contains information about upgrading Leyland for existing applications.

AUTHOR

Ido Perlmuter, <ido at ido50.net>

BUGS

Please report any bugs or feature requests to bug-Leyland at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Leyland. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Leyland::Manual

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2010-2014 Ido Perlmuter.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.