Esquite: framework to manage parallel corpus 🌽

What is Esquite?

Esquite is a framework intended for people who have parallel corpus (bilingual texts) and wish to get a web system that allows them to upload documents, manage them and perform queries based on words and phrases in both languages.

Features

Perform advanced queries in your parallel corpus thanks to the search engine Elasticsearch
Manage your documents through the corpus administrator
Customization of the Web Client
- Colors
- Keyboard with special characters (useful for non-english languages)
- Add custom html information to the views: help, about corpus, links, etc.
New features in development

Example: Tsunkua Corpus Paralelo Español-Otomí

Docs

For a full installation guide, tutorials and project structure you can check our documentation.

Dependencies

git
Elasticsearch 7.6 or higher
python 3.7 or higher
poetry

Installation

Install and run elasticsearch

Note: Check the official page of Elasticsearch to complete this step depending on your OS. Alternatively you can use docker for easier installation.

Install poetry in your system

$ curl -sSL https://install.python-poetry.org | python3 -

Clone this repo

$ git clone https://github.com/ElotlMX/Esquite --depth=1

Install dependencies

Change to the directory's project and intall dependencies. Switch to project enviroment
```
$ cd Esquite
$ poetry install --no-dev --no root
$ poetry shell
```
Launch the installation wizard and type the information requested
```
(env)$ python wizard.py
```
Note: The wizard automatically create an elasticsearch index. Alternatively you can run the curl command below to create an index manually before running the wizard. Default configs can be founded in the file elastic-config.json
```
$ curl -X PUT -H "Content-Type: application/json" -d @elastic-config.json localhost:9200/<index-name>
```
Apply django migrations
```
(env)$ python manage.py migrate
```

Run django in background

(env)$ python manage.py runserver 0.0.0.0:8000 &

Go to your browser at http://localhost:8000/ to see Esquite running :)

Note: For an in detail deployment guide see please contact us

Docker image alternative: `Esquite-Docker`

Alternatively, it is possible to use Esquite and deploy it in an easier way by using our official Docker image.

Detailed documentation is available on:

Esquite-Docker Github : https://github.com/ElotlMX/Esquite-docker
Esquite-Docker Dockerhub : https://hub.docker.com/r/elotlmx/esquite

Contact

Are you a speaker/researcher of a minority language and would like to upload your parallel corpus? Contact us: contacto at elotl.mx

Collaborators

Collaborator: Xim (@XimGutierrez) - xim at unam.mx
Mantainer: Diego B. (@umoqnier) - diegobarriga at protonmail.com
DevOps: Javier (@jusafing) - jusafing at jusanet.org

Community

Twitter: @elotlmx
Site: https://elotl.mx/
Email: contacto at elotl.mx

umoqnier/Esquite