README_ES.md

Esquite: framework para administrar corpus paralelos 🌽

Acerca de Esquite

Esquite es un framework que está destinado a personas que poseen corpus paralelos (textos bilingües) y que deseen obtener un sistema web que les permita subir documentos, administrarlos y realizar búsquedas basadas en palabras y frases en las dos lenguas.

Características

• Realizar búsquedas avanzadas atreves de tus corpus paralelos gracias al motor de búsquedas de Elasticsearch
• Gestionar tus documento por medio de su administrador de corpus
• Personalización de la interfaz web
  • Colores
  • Teclado con caracteres especiales (útil para lenguas minorizadas)
  • Agregar información personalizada a las vistas: Ayuda, Acerca del Corpus, Links, etc.
• Nuevas características en desarrollo

Ejemplo: Tsunkua Corpus Paralelo Español-Otomí

Contacto

¿Eres hablante/estudioso de una lengua minorizada y te gustaría poner tu corpus paralelo en línea? Contactamos: contacto at elotl.mx

Colaboradoras

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

Comunidad

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

Documentación

Para una guía de instalación completa, tutoriales y estructura del proyecto puedes revisar nuestra documentación.

Dependencias

• git
• Elasticsearch 7.6 o mayor
• python3.6 o mayor
  • pip
  • Opcional: virtualenv: Guía de instalación virtualenv

Instalación en servidor

1. Instalar y correr elasticsearch

   Nota: Puedes consultar la página oficial de Elasticsearch para completar este paso dependiendo de tu Sistema Operativo

2. Clona este repositorio

   $ git clone https://github.com/ElotlMX/Esquite

3. Preparación del entorno

   Entrar a la carpeta del proyecto, crea un entorno virtual de python con virtualenv y activarlo

   $ cd Esquite
   $ virtualenv env -p /usr/bin/python3
   $ source env/bin/activate

4. Instalar las dependencias

   (env)$ pip install -r requirements.txt

5. Iniciar el asistente de instalación e ingresar los datos que piden

   (env)$ python wizard.py

   Nota: El asistente menciona que debemos tener un índice de elasticsearh previamente creado. Para crear dicho índice puede ejecutar el siguiente comando.

   $ curl -X PUT -H "Content-Type: application/json" -d @elastic-config.json localhost:9200/<nombre-de-tu-indice>

   Donde dice <nombre-de-tu-indice> deberás poner el nombre que desees y ese será el nombre del índice para poner en el asistente de instalación.

6. Aplicar migraciones de django

   (env)$ python manage.py migrate

7. Correr django en segundo plano

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