Gitiles
Code Review Sign In
korap.ids-mannheim.de / KorAP / Kalamar / 834e76165c8ecae1f2e16f52ef4e27e62ade91dd
commit834e76165c8ecae1f2e16f52ef4e27e62ade91dd[log] [tgz]
authorAkron <nils@diewald-online.de>Mon Sep 12 13:11:05 2016 +0200
committerAkron <nils@diewald-online.de>Mon Sep 12 13:11:05 2016 +0200
treed5ef7744b7e93d5bfdac366d4e7406198ab34cff
parent75396f60e709c843b7c95365e78f6805707ec37f [diff]
Added localization note to readme
3 files changed
tree: d5ef7744b7e93d5bfdac366d4e7406198ab34cff
  1. dev/
  2. lib/
  3. script/
  4. t/
  5. templates/
  6. .gitignore
  7. Changes
  8. Gruntfile.js
  9. kalamar.conf
  10. kalamar.dict
  11. LICENSE
  12. Makefile.PL
  13. package.json
  14. README.md
README.md

Kalamar

Kalamar is a Mojolicious-based user interface frontend for the KorAP Corpus Analysis Platform.

Kalamar Screenshots

! This software is in its early stages and not stable yet! Use it on your own risk!

INSTALLATION

Setup

To fetch the latest version of Kalamar ...

$ git clone https://github.com/KorAP/Kalamar
$ cd Kalamar

Generate Static Asset Files

To generate the static asset files (scripts, styles, images ...), you need NodeJS > 0.8 and npm. For processing Sass, you will need Ruby with the sass gem in addition. This will probably need administration rights.

$ npm install
$ grunt

Start Server

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. There is no need to install Kalamar on your system.

$ cpanm --installdeps .
$ perl Makefile.PL
$ make test

or

$ cpanm .

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 the KorAP API at the IDS. You may not have access to this server!

Localization

To create a localized version of Kalamar, start the localize command with the default locale en followed by the target locale, e.g. pl for polish.

$ perl script/kalamar localize en 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/app.

COPYRIGHT AND LICENSE

Bundled Software

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.

Original Software

Copyright (C) 2015-2016, IDS Mannheim
Author: Nils Diewald

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.