# PODNAME: Yancy::Help::Standalone # ABSTRACT: How to run Yancy without writing Perl code __END__ =pod =head1 NAME Yancy::Help::Standalone - How to run Yancy without writing Perl code =head1 VERSION version 1.069 =head1 SYNOPSIS To see the Yancy UI in action with some sample data, do this in a checkout of the repo: $ cp eg/test-app/yancy.data.json yancy.data.json $ cp eg/test-app/myapp.conf yancy.conf # t/lib is to provide Yancy::Backend::Test $ perl -Ilib -It/lib bin/yancy daemon & Having done the above, now visit L. Alternatively, you can try some test data, together with the L feature to automatically configure the API from the database schema: $ export TEST_ONLINE_SQLITE=sqlite:/tmp/test.db # run the test, put the test data in a disk file $ prove -l t/backend/sqlite.t $ echo >yancy.conf "{backend=>'$TEST_ONLINE_SQLITE', read_schema=>1}" $ perl -Ilib bin/yancy daemon & As a further bit of control, you can create your F as above, then use an OpenAPI spec instead of reading the schema from the database: $ SPECFILE=openapi.json $ perl -Ilib bin/yancy get /yancy/api >$SPECFILE $ echo >yancy.conf "{backend=>'$TEST_ONLINE_SQLITE', openapi=>'$SPECFILE'}" $ perl -Ilib bin/yancy daemon & =head1 Getting Started To run Yancy as a standalone application, you must create a C configuration file that defines how to connect to your database and what the data inside looks like. See L for details. B Yancy does not have authentication or authorization built-in. If you want to control which users have access to data, you should use a plugin like L or an HTTP proxy with these features. Once the application is started, you can navigate to C<< http://127.0.0.1:3000/yancy >> to see the Yancy administration app. Navigate to C<< http://127.0.0.1:3000/ >> to see the getting started page. =head1 Rendering Content In the standalone app, all paths besides the C application are treated as paths to templates. If a specific template path is not found, Yancy will search for an C template in the same directory. If that template is not found, an error is returned. The templates are found in the C directory. You can change the root directory that contains the C directory by setting the C environment variable. Template names must end with C<< .format.ep >> where C is the content type (C is the default). You can render plain text (C), JSON (C), XML (C), and others. Database content can be read by using the database helpers that Yancy provides. =over =item * C<< yancy->list( $schema ) >> - Get a list of items =item * C<< yancy->get( $schema, $id ) >> - Get a single item =item * C<< yancy->set( $schema, $id, $data ) >> - Update an item =item * C<< yancy->delete( $schema, $id ) >> - Delete an item =item * C<< yancy->create( $schema, $data ) >> - Create an item =back Some example template code: %# Get a list of people % my @people = app->yancy->list( 'people' ); %# Show a list of people names

<%= $person->{name} %>

%# Get a single person with ID 1 % my $person = app->yancy->get( 'people', 1 ); %# Write the person's name to the page

Hi, my name is <%= $person->{name} %>.

More information about L helpers is available at L. =head1 Plugins In standalone mode, you can configure plugins in the Yancy configuration file. Plugins can be standard L (with a name starting with C, or they can be specifically for Yancy (by extending L and having a name starting with C). Plugins are configured as an array of arrays under the `plugins` key. Each inner array should have the plugin's name and any arguments the plugin requires, like so: { plugins => [ [ 'PodRenderer' ], [ CGI => [ "/cgi-bin/script" => "/path/to/cgi/script.pl" ] ], ], } =head1 SEE ALSO L =head1 AUTHOR Doug Bell =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2020 by Doug Bell. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut