commit | 1120a58cccadfd03f69faf7f9349dcef3c6ece04 | [log] [tgz] |
---|---|---|
author | Akron <nils@diewald-online.de> | Tue Oct 17 12:29:16 2017 +0200 |
committer | Akron <nils@diewald-online.de> | Tue Oct 17 12:29:16 2017 +0200 |
tree | 3bc21456f934c9014fef8d3ae340e43e5a43c1af | |
parent | 9fc5f80ef69119dee58a3c0c04bf2c6a7dc24b36 [diff] |
Optimized embedded tutorial for mobile Change-Id: I0b345c75cbd68bd1f1205a313ddbb7ecd94b58c3
Kalamar is a Mojolicious-based user interface frontend for the KorAP Corpus Analysis Platform.
! This software is in its early stages and not stable yet! Use it on your own risk!
To fetch the latest version of Kalamar ...
$ git clone https://github.com/KorAP/Kalamar
To generate the static asset files (scripts, styles, images ...), you need NodeJS > 0.8 and npm (maybe bundled with your version of NodeJS). For processing Sass, you will need Ruby with the sass
gem in addition. This will probably need administration rights, depending on your installation path. These tools may also be available with a package manager.
You can check, if all tools are available using
$ npm -v $ sass -v
Afterwards you can install grunt and run grunt to create the assets.
$ cd Kalamar $ npm install -g grunt-cli $ npm install $ grunt
Whenever the assets change, just rerun grunt
.
Kalamar uses the Mojolicious framework, that expects a Perl version of at least 5.10.1. The recommended environment is based on Perlbrew with App::cpanminus.
Some perl modules are not on CPAN yet, so you need to install them from GitHub. The easiest way to do this is using App::cpanminus. This will probably need administration rights.
$ cpanm git://github.com/Akron/Mojolicious-Plugin-Search.git $ cpanm git://github.com/Akron/Mojolicious-Plugin-Localize.git
Then install the dependencies as always and run the test suite.
$ cd Kalamar $ cpanm --installdeps . $ perl Makefile.PL $ make test
Kalamar can be deployed like all Mojolicious apps. The easiest way is to start the built-in server:
$ perl script/kalamar daemon
Kalamar will then be available at localhost:3000
in your browser.
By default, Kalamar tries to connect to localhost:9999
. You may change that endpoint to the KorAP API provider in in the configuration (see Kustvakt for further information).
The basic configuration file is kalamar.conf
. To define derivations, create a configuration file with the pattern kalamar.[MYNAME].conf
and follow the descriptions in kalamar.conf
.
To create a localized version of Kalamar, start the localize
command with the target locale as its argument, e.g. pl
for polish.
$ perl script/kalamar localize pl
The newly defined dictionary file can then be added to the resource definition of the Localize
plugin.
Currently the JavaScript translations are separated and stored in dev/js/src/loc
.
ALERTIFY.js is released under the terms of the MIT License. Almond is released under the terms of the BSD License. dagre is released under the terms of the MIT License. Highlight.js is released under the terms of the BSD License. Jasmine is released under the terms of the MIT License. RequireJS is released under the terms of the BSD License. Font Awesome by Dave Gandy is released under the terms of the SIL OFL 1.1. Benchmark.js is released under the terms of the MIT License. lodash is released under the terms of the MIT License. Platform.js is released under the terms of the MIT License.
Copyright (C) 2015-2017, IDS Mannheim
Author: Nils Diewald Contributor: Susanne Feix (Translations)
Kalamar is developed as part of the KorAP Corpus Analysis Platform at the Institute for the German Language (IDS), member of the Leibniz-Gemeinschaft and supported by the KobRA project, funded by the Federal Ministry of Education and Research (BMBF).
Kalamar is free software published under the BSD-2 License.