Ado::Manual - Getting started with Ado
cd where/is/Ado bin/ado daemon Server available at http://127.0.0.1:3000
Ado is a framework for web projects based on Mojolicious, written in the Perl programming language.
Ado is a typical Mojo application yet it adds some default configuration and a model layer - Mojolicious::Plugin::DSC. An SQLite database is bundled in the distribution at etc/ado.sqlite to get started quickly.
etc/ado.sqlite
Ado is meant to be installed into a folder of your choice. It can go into the siteprefixexp folder of your non-system Perl distro or in its own folder.
siteprefixexp
We do not recommend using Ado with your system Perl!
Get a precompiled Perl distro like "Citrus Perl" (http://www.citrusperl.com/download.html) or "ActivePerl Community Edition" (http://www.activestate.com/activeperl/downloads) for your OS, or build your own using App::perlbrew.
Ado can be downloaded from CPAN and installed manually or installed directly from CPAN using cpan or cpanm commandline tools.
cpan
cpanm
To install manually Ado after downloading, run the following commands:
tar -zxf Ado-X.XX.tar.gz cd Ado-X.XX/ perl Build.PL --install_base $HOME/opt/ado #or simply perl Build.PL ./Build installdeps ./Build ./Build test ./Build install
cpanm Ado #or cpan[1]> install Ado Running install for module 'Ado' Running make for B/BE/BEROV/Ado-0.23.tar.gz ... ... BEROV/Ado-0.23.tar.gz ./Build install install -- OK
Installing Ado under your own perlbrew environment
perlbrew init perlbrew install -n perl-5.18.1 --as ado -j 3 perlbrew switch ado perlbrew install-cpanm cpanm Ado
After installing, you can find documentation with the perldoc command. To use perldoc for reading documentation you may need to add the full path to Ado lib/Perl5 directory to PERL5LIB environment variable in case you passed the --install_base to Build.PL.
perldoc
lib/Perl5
PERL5LIB
--install_base
Build.PL
perldoc Ado perldoc Ado::Manual #this page
For better experience run the ado application and read the documentation from your browser.
ado
$HOME/opt/ado/bin/ado daemon
If you installed ado in your Perl distro, you can simply type:
ado daemon
Go to http:/localhost:3000/perldoc
You can report bugs and suggest features at http://github.com/kberov/Ado/issues. Bugs will be considered and fixed as time permits. Feel invited to make pull requests for your contributions.
Of course anybody can contribute by reporting issues via github. To be able to contribute with code some rules need to be kept. This is mandatory for any community project. Generally the rules outlined in Mojolicious::Guides::Contributing apply for Ado too. For specific to Ado rules see Ado::Manual::Contributing.
We expect that you know how to write perl Modules and are familiar with Mojolicious.
Ado strives for strict separation of concerns. The best way to achieve this is to fully separate the client code from the server code. Ado is ideally suited for the purpose thanks to Mojolicious. Every resource is accessible via the REST API. We follow closely and elaborate on the recommendations in "RESTful Service Best Practices" at www.RestApiTutorial.com. See Ado::Manual::RESTAPI.
Ado plugins work the same way as Mojolicious::Plugins and share the same common base trough Ado::Plugin. Ado plugins have one small additional feature. They can load their own configuration from $ENV{MOJO_HOME}/etc/plugins/plugin_name.conf. Business-specific applications for an Ado-based system are usually implemented as plugins. One way to contribute to Ado is by writing plugins.
$ENV{MOJO_HOME}/etc/plugins/plugin_name.conf
See Ado::Manual::Plugins and Ado::Plugin for more information.
Ado, Mojolicious::Guides, Mojolicious::Guides::Contributing, "prefix_vs_install_base" in Module::Build::Cookbook, http://www.thefreedictionary.com/ado.
Authors in order of joining the core team.
Красимир Беров (Krasimir Berov)(berov@cpan.org)
Вълчо Неделчев (Valcho Nedelchev)(kumcho@vulcho.com)
Copyright 2013 Красимир Беров (Krasimir Berov).
This program is free software, you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License v3 (LGPL-3.0). You may copy, distribute and modify the software provided that modifications are open source. However, software that includes the license may release under a different license.
See http://opensource.org/licenses/lgpl-3.0.html for more information.
To install Ado, copy and paste the appropriate command in to your terminal.
cpanm Ado
CPAN shell
perl -MCPAN -e shell install Ado
For more information on module installation, please visit the detailed CPAN module installation guide.