lkrsnik/STARK-web
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README + some small fixes

Browse Source
This commit is contained in:
lkrsnik 2024-03-13 11:07:17 +01:00
parent 33c6731be0
commit ce50960fb5
8 changed files with 76 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -1,28 +1,65 @@
# About
This is a repository where you may access the code for [STARK-web](https://orodja.cjvt.si/stark/).
# Running
Install required libraries using (we presume you have preinstalled python 3.8+):
```shell
pip install -r requirements
```
Move to project directory and write:
```shell
flask run
```
To run project locally.
# Deployment
Website is deployed on 'storitve' server.
After connecting there, clone latest version of this repository to custom location.
Move inside clone repository and build a docker image using the following command (adapt version by modifying cited `2024-01-01`):
```shell
docker build -t stark-web:2024-01-01_1 .
```
Move to the location with docker-compose.yml (`/opt/Docker/STARK-web/`) and adapt `docker-compose.yml` file to be a container of the latest image (in previous example this would be `image: stark-web:2024-01-01_1`)
Run new docker container:
```shell
docker compose up -d
```
# Translations
## Create .pot file
pybabel extract -F babel.cfg -o messages.pot .
Translations are implemented using [flask-babel library](https://pypi.org/project/flask-babel/) (this should already be installed if you followed instructions in Running section).
## Create language .po files
pybabel init -i messages.pot -d translations -l en
pybabel init -i messages.pot -d translations -l sl
## Install gettext
In order to use `msgmerge` command you have to install [gettext](https://www.gnu.org/software/gettext/).
```shell
# Ubuntu command
sudo apt install gettext
```
## Compile changes
pybabel compile -d translations
## Update commands
Install gettext (sudo apt install gettext)
## Update translations commands
```shell
# Move to project directory
# Create .pot file
pybabel extract -F babel.cfg -o messages.pot .
msgmerge translations/sl/LC_MESSAGES/messages.po messages.pot -o translations/sl/LC_MESSAGES/messages.po
msgmerge translations/en/LC_MESSAGES/messages.po messages.pot -o translations/en/LC_MESSAGES/messages.po
# check and delete fuzzy in .po files
# !Check and delete fuzzy in .po files
# Compile changes
pybabel compile -d translations
```
# Deployment
docker build -t stark-web .
docker run -p 8080:8080 stark-web
## Initiate a new language
If new language is introduced, you may use the following command:
```shell
pybabel init -i messages.pot -d translations -l es
```

6
messages.pot
View File

@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2024-03-13 09:03+0100\n"
"POT-Creation-Date: 2024-03-13 11:06+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
@ -172,6 +172,10 @@ msgstr ""
msgid "stark_credits3"
msgstr ""
#: templates/about.html:19
msgid "stark_contact"
msgstr ""
#: templates/base.html:23
msgid "switch_link"
msgstr ""

4
static/css/style.css
View File

@ -115,6 +115,10 @@ td {
width: 80%;
}
.narrower-container {
width: 40%;
}
.redcjvt {
background-color: #e12a26;
}

5
templates/about.html
View File

@ -1,6 +1,6 @@
{% extends "base.html" %}
{% block content %}
<div class="container">
<div class="container narrower-container">
<br>
<div class="row">
<div class="col s12">
@ -14,6 +14,9 @@
<br>
<br>
{{ _('stark_credits') }}<a target="_blank" href="https://spot.ff.uni-lj.si/">{{ _('SPOT: A Treebank-Driven Approach to the Study of Spoken Slovenian') }}</a>{{ _('stark_credits2') }}<a target="_blank" href="https://github.com/clarinsi/STARK">https://github.com/clarinsi/STARK</a>{{ _('stark_credits3') }}
<br>
<br>
{{ _('stark_contact') }}
</div>
</div>
</div>

BIN
translations/en/LC_MESSAGES/messages.mo
View File

Binary file not shown.

6
translations/en/LC_MESSAGES/messages.po
View File

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2024-03-13 09:03+0100\n"
"POT-Creation-Date: 2024-03-13 10:26+0100\n"
"PO-Revision-Date: 2024-02-14 14:36+0100\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: en <LL@li.org>\n"
@ -196,6 +196,10 @@ msgstr ""
msgid "stark_credits3"
msgstr "."
#: templates/about.html:19
msgid "stark_contact"
msgstr "Should you have any additional questions or require assistance with the tool, please contact kaja.dobrovoljc@ff.uni-lj.si."
#: templates/base.html:23
msgid "switch_link"
msgstr "?lang=sl"

BIN
translations/sl/LC_MESSAGES/messages.mo
View File

Binary file not shown.

6
translations/sl/LC_MESSAGES/messages.po
View File

@ -6,7 +6,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2024-03-13 09:03+0100\n"
"POT-Creation-Date: 2024-03-13 10:26+0100\n"
"PO-Revision-Date: 2024-02-14 14:36+0100\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: sl <LL@li.org>\n"
@ -197,6 +197,10 @@ msgstr ""
msgid "stark_credits3"
msgstr ") nekoliko poenostavljen nabor nastavitev."
#: templates/about.html:19
msgid "stark_contact"
msgstr "Za dodatna vprašanja ali pomoč pri uporabi orodja se obrnite na kaja.dobrovoljc@ff.uni-lj.si."
#: templates/base.html:23
msgid "switch_link"
msgstr "?lang=en"