NAME

Slovo - Искони бѣ Слово

SYNOPSIS

Install Slovo locally with all dependencies in less than two minutes

    date
    curl -L https://cpanmin.us | perl - -M https://cpan.metacpan.org -q -n -l \
    ~/opt/slovo Slovo
    date

Run slovo for the first time in debug mode

    ~/opt/slovo/bin/slovo daemon

Visit http://127.0.0.1:3000 For help visit http://127.0.0.1:3000/perldoc

DESCRIPTION

This is a useable release!

Slovo is a simple and extensible Mojolicious CMS with nice core features like:

  • Multi-language pages - DONE;

  • Cached published pages and content - DONE;

  • Multi-domain support - DONE;

  • Multi-user support - BASIC;

  • User registration - TODO;

  • User sign in - DONE;

  • Managing pages, content, domains, users - BASIC;

  • Managing groups - TODO;

  • Multiple groups per user - BASIC;

  • Fine-grained access permissions per page and it's content in the site - DONE;

  • Automatic 301 and 308 (Moved Permanently) redirects for renamed pages and content - DONE;

  • Embedded fonts for displaying all Azbuka and Glagolitsa characters - DONE;

  • OpenAPI 2.0 (Swagger) REST API - BASIC;

  • Trumbowyg - A lightweight WYSIWYG editor.

  • Example startup script for systemd and Apache 2.4 vhost configuration file.

  • and more to come…

By default Slovo comes with SQLite database, but support for PostgreSQL or MySQL is about to be added when needed. It is just a question of making compatible and/or translating some limited number of SQL queries to the corresponding SQL dialects. Contributors are wellcome.

The word "slovo" (слово) has one unchanged during the senturies meaning in all slavic languages. It is actually one language that started splitting apart less than one thousand years ago. The meaning is "word" - the God's word. Hence the self-naming of this group of people qr/sl(o|a)v(e|a|i)n(i|y|e)/ - people who have been given the God's word or people who can speak. All others were "mute", hense the naming (немци)...

INSTALL

All you need is a one-liner, it takes less than a minute.

    $ curl -L https://cpanmin.us | perl - -M https://cpan.metacpan.org -n -l ~/opt/slovo Slovo

We recommend the use of a Perlbrew environment.

If you already downloaded it and you have cpanm.

    $ cpanm -l ~/opt/slovo Slovo-XXXX.XX.XX.tar.gz

Or even if you don't have cpanm.

    tar zxf Slovo-XXXX.XX.XX.tar.gz
    cd  Slovo-XXXX.XX.XX
    perl Makefile.PL INSTALL_BASE=~/opt/slovo && make && make test && make install

USAGE

    cd /path/to/installed/slovo
    # ...and see various options
    ./bin/slovo

CONFIGURATION, PATHS and UPGRADING

Slovo is a Mojolicious application which means that everything applying to Mojolicious applies to it too. Slovo main configuration file is in lib/Slovo/resourses/etc/slovo.conf. You can use your own by setting $ENV{MOJO_CONFIG}. New routes can be described in routes.conf. See Mojolicious::Plugin::RoutesConfig for details and examples.

$ENV{MOJO_HOME} (where you installed Slovo) is automatically detected and used. All paths, used in the application, are expected to be its children. You can add your own templates in $ENV{MOJO_HOME}/templates and they will be loaded and used with priority. You can theme your own instance of Slovo by just copying $ENV{MOJO_HOME}/lib/Slovo/resources/templates to $ENV{MOJO_HOME}/templates and modify them. You can add your own static files to $ENV{MOJO_HOME}/public.

You can have separate static files and templates per domain under $ENV{MOJO_HOME}/domove/your.domain/public, $ENV{MOJO_HOME}/domove/your.other.domain/templates, etc. See $ENV{MOJO_HOME}/domove/localhost for example.

Last but not least, you can add your own classes into $ENV{MOJO_HOME}/site/lib and (why not) replace entirely some Slovo classes or just extend them. $ENV{MOJO_HOME}/bin/slovo will automatically load them.

With all the above, you can upgrade Slovo by just installing new versions over it and your files will not be touched. And of course, we know that you are using versioning just in case anything goes wrong.

ATTRIBUTES

Slovo inherits all attributes from Mojolicious and implements the following new ones.

resources

  push @{$app->static->paths}, $app->resources->child('public');

Returns a Mojo::File instance for path "resources" in Slovo next to where Slovo.pm is installed.

validator

  my $validator = $app->validator;
  $app          = $app->validator(Slovo::Validator->new);

Validate values, defaults to a Slovo::Validator object.

  # Add validation check
  $app->validator->add_check(foo => sub {
    my ($v, $name, $value) = @_;
    return $value ne 'foo';
  });

  # Add validation filter
  $app->validator->add_filter(quotemeta => sub {
    my ($v, $name, $value) = @_;
    return quotemeta $value;
  });

METHODS

Slovo inherits all methods from Mojolicious and implements the following new ones.

load_class

A convenient wrapper with check for "load_class" in Mojo::Loader. Loads a class and croaks if something is wrong. This could be a helper.

startup

    my $app = Slovo->new->startup;

Starts the application. Adds hooks, prepares $app->routes for use, loads configuration files and applies settings from them, loads plugins, sets default paths, and returns the application instance.

HOOKS

Slovo adds custom code to the following hooks.

around_dispatch

On each request we determine the current host and modify the static and renderer paths accordingly. This is how the multi-domain support works.

before_dispatch

On each request we check if we have logged in user and set the current user to guest if we don't. This way every part of the application (including newly developed plugins) can count on having a current user. It is used for determining the permissions for any resource in the application. The user is available as $c->user.

HELPERS

Slovo implements the following helpers.

openapi_spec

We need to have our openapi API specification always at hand as a unified source of truth so here it is.

    #anywhere via $app or $c, even not via a REST call
    state $columns =
        $c->openapi_spec('/paths/~1страници/get/parameters/3/default');
    [
      "id",
      "pid",
      "alias",
      "title",
      "is_dir"
    ]

BUGS, SUPPORT, COMMIT, DISCUSS

Please use issues at GitHub, fork the project and make pull requests.

AUTHOR

    Красимир Беров
    CPAN ID: BEROV
    berov на cpan точка org
    http://i-can.eu

CONTRIBUTORS

Ordered by time of first commit.

  • MANWAR (Mohammad S Anwar)

  • KABANOID (Mikhail Katasonov)

COPYRIGHT

This program is free software licensed under the Artistic License 2.0.

The full text of the license can be found in the LICENSE file included with this module.

TODO

Add fine-grained permissions for accessing and modifying resources in the administration area - http://localhost:3000/Ꙋправленѥ.

Considerably improve the Adminiastration UI - now it is quite simplistic and lacks essential features.

Add simplemde-markdown-editor to the distro and use it to prepare markdown as html in the browser. (https://github.com/sparksuite/simplemde-markdown-editor) (https://github.com/Inscryb/inscryb-markdown-editor)

Consider using Mithril or Dojo or something light as frontend framework for building UI. We already use jQuery from Mojolicious. (https://github.com/MithrilJS/mithril.js), (https://dojo.io/)

Consider using DataTables jQuery plugin for the administrative panel.

SEE ALSO

Slovo::Plugin::TagHelpers, Slovo::Plugin::DefaultHelpers, Slovo::Validator, Mojolicious, Mojolicious::Guides