Using the web interface is very easy and you can do that on the Korero website.
If you want to write an application that needs to do spell checking, you can use our JSON interface. Use a POST request and provide the following:
textis the text to checklangis the language to useformat=jsonswitches to the output from HTML to JSON
Here's how to test it from the command line:
curl https://korero.org/check \
--form text="Ein Mensch und eine Fliege im Raum" \
--form lang="en-US" \
--form format=json
The Result in this case – given that the text is in German and the language requested is US English:
{
"eine": ["wine","seine","Seine","Reine","Heine","sine","nine","tine","line","cine","dine","mine","pine","fine","vine"],
"Ein": ["In","Erin","Edin","Evin","Sin","Tin","Din","Gin","Min","Pin","Bin","Yin","Fin","Kin","Win"],
"und": ["ind","undo","fund","Lund","dun","end","and","Ind","undue","under","unit"],
"Raum": ["Ram","Raul","Ra um","Ra-um","Arum","Rum","Trauma","Radium","Maura","Umbra","Roam","RAM"],
"im": ["mi","um","om","in","i","m","ism","aim","rim","dim","imp","him","vim","Sim","Tim"],
"Fliege":["Liege","F liege","Flinger","Flier","Fledge","Flicker","Flexed"]
}If you want to write an application that needs generate some voice audio, use a POST request and provide the following:
textis the text to checkvoiceis the voice to use (based onespeak --voice)
Here's how to test it from the command line:
curl https://korero.org/say \
--form text="Ein Mensch und eine Fliege im Raum" \
--form voice="de" | mpg321 -
This application uses Mojolicious. While you're developing the application:
morbo server.pl
This will run the server on port 3000. Visit http://localhost:3000
to test it. As soon as you edit the file, morbo will restart the
server. You just need to reload the page to see any changes you made.
Learn more: Mojolicious::Guides::Tutorial.
Use Hypnotoad which is part of Mojolicious.
hypnotoad server.pl
Verify that it is working by visiting http://localhost:8080.
If you're using Apache, configure your virtual server to act as a
proxy and pass requests through to port 8080. Make sure you have
mod_proxy and mod_proxy_httpenabled. Our setup also uses an extra
header. Thus, you also need mod_headers.
sudo a2enmod proxy
sudo a2enmod proxy_http
sudo a2enmod headers
sudo service apache2 restart
Once this works, you need to write a config file for your site. Here's ours:
<VirtualHost *:80>
ServerName korero.org
Redirect permanent / https://korero.org/
</VirtualHost>
<VirtualHost *:443>
ServerAdmin kensanata@gmail.com
ServerName korero.org
DocumentRoot /home/alex/korero.org
<Directory /home/alex/korero.org>
Options None
AllowOverride None
Order Deny,Allow
Allow from all
</Directory>
ProxyPass /.well-known !
ProxyPass / http://korero.org:8080/ keepalive=On
RequestHeader set X-Forwarded-Proto "http"
SSLEngine on
SSLCertificateFile /etc/letsencrypt.sh/certs/korero.org/cert.pem
SSLCertificateKeyFile /etc/letsencrypt.sh/certs/korero.org/privkey.pem
SSLCertificateChainFile /etc/letsencrypt.sh/certs/korero.org/chain.pem
SSLVerifyClient None
</VirtualHost>
Reload your Apache config using sudo service apache2 graceful.
This is based on the Mojolicious Cookbook, The SSL setup from Let’s Encrypt using letsencrypt.sh.
sudo apt-get install libmojolicious-perl libtext-hunspell-perl espeak lame
Note that libmojolicious-perl is too old on Debian Wheezy. You can
try to install it anyway, but if it fails, you'll have to install the
latest from CPAN:
cpan Mojolicious
You also need to install some dictionaries. These should all end up in
/usr/share/hunspell. You might want to try something like the
following:
sudo apt-get install hunspell-an hunspell-ar hunspell-be \
hunspell-da hunspell-de-de hunspell-de-at hunspell-de-ch \
hunspell-en-us hunspell-en-ca hunspell-eu-es hunspell-fr \
hunspell-gl-es hunspell-hu hunspell-kk hunspell-ko hunspell-ml \
hunspell-ne hunspell-ro hunspell-ru hunspell-se hunspell-sh \
hunspell-sr hunspell-sv-se hunspell-uz hunspell-vi
This will result in files like de_CH.dic and de_CH.aff in
/usr/share/hunspell. We need both of these files in order to
recognize a valid language.
If you're using Homebrew, things should be easy.
Use brew install espeak lame to install
eSpeak
and LAME.
Use brew install hunspell to install the spell checker
and note the following:
Dictionary files (*.aff and *.dic) should be placed in
~/Library/Spelling/ or /Library/Spelling/. Homebrew itself provides no
dictionaries for Hunspell, but you can download compatible
dictionaries from other sources, such as
https://wiki.openoffice.org/wiki/Dictionaries .
If you already have Libre Office installed, the files are easy to find.
alex@Megabombus:~$ locate en_US.aff
/Applications/LibreOffice.app/Contents/share/extensions/dict-en/en_US.aff
The files will all be in
/Applications/LibreOffice.app/Contents/share/extensions/dict-* and
the files will end in *.aff and *.dic.
I'm using Perlbrew to install a new Perl and
run it alongside the system default. If you follow the instructions,
you'll end up with the following line in your ~/.bashrc:
source ~/perl5/perlbrew/etc/bashrc
Just remember that if you write CGI scripts or similar things, you can
no longer rely on the shebang line #!/usr/bin/perl – you'll be using
something like
#!/Users/alex/perl5/perlbrew/perls/perl-5.18.2/bin/perl instead.
When installing from CPAN, Text::Hunspell wouldn't install:
...
Running test for module 'Text::Hunspell'
COSIMO/Text-Hunspell-2.11.tar.gz
Has already been unwrapped into directory /Users/alex/.cpan/build/Text-Hunspell-2.11-XRrGMO
COSIMO/Text-Hunspell-2.11.tar.gz
No 'Makefile' created
, not re-running
CPAN: CPAN::Meta loaded ok (v2.150005)
I did it manually:
alex@Megabombus:~$ cd /Users/alex/.cpan/build/Text-Hunspell-2.11-XRrGMO/
alex@Megabombus:~/.cpan/build/Text-Hunspell-2.11-XRrGMO$ perl Makefile.PL
Checking if your kit is complete...
Looks good
Generating a Unix-style Makefile
Writing Makefile for Text::Hunspell
Writing MYMETA.yml and MYMETA.json
alex@Megabombus:~/.cpan/build/Text-Hunspell-2.11-XRrGMO$ make
...
alex@Megabombus:~/.cpan/build/Text-Hunspell-2.11-XRrGMO$ make test
...
All tests successful.
Files=5, Tests=17, 0 wallclock secs ( 0.06 usr 0.03 sys + 0.19 cusr 0.05 csys = 0.33 CPU)
Result: PASS
alex@Megabombus:~/.cpan/build/Text-Hunspell-2.11-XRrGMO$ make install
...
cpan Mojolicious