Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/briandfoy/task-mojolearningenvironment

Everything you need to play with Mojolicious, and more
https://github.com/briandfoy/task-mojolearningenvironment

mojolicious perl perl-bundle

Last synced: about 2 months ago
JSON representation

Everything you need to play with Mojolicious, and more

Awesome Lists containing this project

README

        

=pod

=encoding utf8

=for HTML

=for HTML

=for HTML

=for HTML

=for HTML Coverage Status

=for HTML

=for HTML

=head1 The Task::MojoLearningEnvironment module

This is the I for the L Perl
module. This is a fancy way to install the Perl stuff that I want
for a Mojolicious class.

You're probably looking at this because you don't know where else to
find what you're looking for. Read this once and you might never have
to read one again for any Perl module.

=head2 Quickstart

Install L, available for
Linux, Windows, and Mac OS X.

Add an Ubuntu image. Other distros may work, but the provisioning
script assumes Ubuntu.

% vagrant box add ubuntu/trusty64 https://atlas.hashicorp.com/ubuntu/boxes/trusty64

Install the C plugin. This allows you to take
snapshots of your vagrant box. With a snapshot, you can mess up
everything with no worries since you can go back to any point.

% vagrant plugin install vagrant-vbox-snapshot

Start vagrant. It reads the F in the current directory,
and should provision the box following the F
script. This will take awhile the first time:

% vagrant up

Before you do anything, take a snapshot with the beginning state. I like
to name this snapshot "first":

% vagrant snapshot take first

If you like what you have, take another snapshot.

% vagrant snapshot take provisioned

Once up, you can F into the box:

% vagrant ssh

When you want to take the box down:

% vagrant down

=head3 Without vagrant

You might try the F program as a normal shell
script. On Ubuntu it should setup everything.

=head2 Documentation

To read about L, look at the embedded
documentation in the module itself. Inside the distribution, you can
format it with L:

% perldoc lib/Task/MojoLearningEnvironment.pm

If you have already installed the module, you can specify the module
name instead of the file location:

% perldoc Task::MojoLearningEnvironment

You can read the documentation and inspect the meta data at
L.

The standard module documentation has example uses in the SYNOPSIS
section, but you can also look in the I directory (if it's
there), or look at the test files in I.

=head2 Installation

You can install this module with a CPAN client, which will resolve
and install the dependencies:

% cpan Task::MojoLearningEnvironment
% cpanm Task::MojoLearningEnvironment

You can also install directly from the distribution directory, which
will also install the dependencies:

% cpan .
% cpanm .

You could install just this module manually:

% perl Makefile.PL
% make
% make test
% make install

You probably don't want to do that unless you're fiddling with the
module and only want to run the tests without installing anything.

=head2 Source location

The meta data, such as the source repository and bug tracker, is in
I or the I files it creates. You can find that on
those CPAN web interfaces, but you can also look at files directly in
the source repository:

=over 4

=item * L

=back

If you find a problem, file a ticket in the L:

=over 4

=item * L

=back

=head2 Getting help

Although I'm happy to hear from module users in private email,
that's the best way for me to forget to do something.

Besides the issue trackers, you can find help at
L or
L, both of which have many
competent Perlers who can answer your question, almost in real time.
They might not know the particulars of this module, but they can help
you diagnose your problem.

You might like to read L.

=head2 Copyright and License

You should have received a I file, but the license is also noted
in the module files. About the only thing you can't do is pretend that
you wrote code that you didn't.

=head2 Good luck!

Enjoy,

brian d foy, [email protected]

=cut