Skip to content

Latest commit

 

History

History
executable file
·
81 lines (49 loc) · 2.77 KB

README-ES.md

File metadata and controls

executable file
·
81 lines (49 loc) · 2.77 KB
Raw

ODIÓMETRO

Ya disponible en https://odiometro.es

Este es un proyecto que ayuda a medir el nivel de odio que se genera en Twitter en tiempo real.

El objetivo de este proyecto es hacernos conscientes del nivel de debate que se produce en España, y el amplio uso de insultos, descalificaciones, etc. que se producen en Twitter. También recoge tweets de otros países hispanoparlantes.

La web hace uso de las siguientes tecnologías:

  • NodeJS / Express
  • Socket.io
  • MySQL
  • VueJS
  • SASS
  • Grunt

Instalación

  1. Clonar el repositorio

git clone [email protected]:ojoven/odiometro.git

  1. Desde la raíz del proyecto (instalará express, socket y otras librerías)

npm install

  1. También desde la carpeta /public (instalará grunt y plugins, vue)

cd public && npm install

  1. Crea una base de datos e importa el dump en db/odiometro.sql

mysql -u [username] -p [dbname] < db/odiometro.sql

4.2 Configura los datos de tu DB en /config/database_odiometro.json o si estás creando el odiómetro en tu país database_odiometro.pais.json

mysql -u [username] -p [dbname] < db/odiometro.sql

  1. Corre el grunt desde /public

grunt

  1. Lanza la app

node app.js

  1. Si has creado tu propia versión de país (o de otro estilo tipo amorómetro)

node app.js [nombredebot]

IMPORTANTE

Tendrás que crear una app en Twitter y rellenar los datos de consumer key y secret, y access_token y secret en twitter_odiometro.json o twitter_odiometro.pais.json.

No sé bien cómo funciona la API de Twitter ahora, ya que estuvieron implementando bastantes restricciones que igual no afectan a apps antiguas pero sí a las nuevas. Si tienes algún problema o sabes cómo va, no dudes en escribir en las Issues.

Notas adicionales de desarrollo

  • Los componentes Vue del frontend se encuentran en public/js/src/app/components
  • Otros archivos interesantes son:
    • bus.js -> Lo utilizamos como bus de eventos para emitir / recibir eventos
    • lib.js -> Una instancia Vue que nos sirve como librería de funciones (para funcionalidades compartidas entre componentes)
    • socket.js -> Simplemente inicializa socket.io en el frontend
    • store.js -> Una clase "store" donde almacenamos variables que serán compartidas por varios componentes
    • vue-instance.js -> Inicializa la instancia Vue principal
  • en vendor/smoothie.js tenemos la librería que renderiza la gráfica en tiempo real
  • si tienes sugerencias sobre cómo optimizar el código, hacerlo más legible, refactorizar, etc. las sugerencias y los pull requests son bienvenidos.

Contacta

Si tienes alguna duda, sugerencia, crítica o palabra de odio, puedes contactarme en https://twitter.com/ojoven