Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gugustinette/worldwhere

Open Source Tools to visualize Ukraine/Russia conflict
https://github.com/gugustinette/worldwhere

Last synced: about 1 month ago
JSON representation

Open Source Tools to visualize Ukraine/Russia conflict

Awesome Lists containing this project

README

        

# World Where

## Introduction

Ce projet vise à informer de la situation courante entre l'Ukraine et la Russie.
Toutes les 30 secondes, le serveur récupère les 20 tweets récents en lien avec le sujet, et en extrait les entités pour tenter de quantifier les actualités.

## Ressources
- API de Twitter : https://developer.twitter.com/en/docs
- Stanford NER (pour reconnaître les entités) : https://nlp.stanford.edu/software/CRF-NER.html

## Pré-requis
- Java
- NodeJS et npm
- La librairie pm2 installée globalement via NPM : `npm install -g pm2`
- La librairie serve, installée globalement vua NPM : `npm install -g serve`
- MongoDB Community Edition installé et lancé localement

## Installation
- Télécharger le projet
- Créer un fichier `TWITTER_KEY.json` dans le dossier `/access` contenant le champ suivant avec le token de l'API Twitter
```
{
"bearer_token": "token"
}
```
- Ouvrir un terminal de commande puis :
- Installer les dépendances
```
npm install
```
- Donner les droits d'éxécution aux scripts
```
chmod 777 scripts/*
```
- Installer la bibliothèque Stanford NER
```
npm run ner-install
```
Cela devrait avoir crée un dossier lib contenant la bibliothèque Java Stanford NER.
- Lancer le projet avec :
```
npm start
```
Cela devrait avoir servi localement les 3 services via pm2.

## Services
Le projet est composé de 3 services :
- Le client, correspondant au projet Vue en front, qui peut être lancé via `npm run client` pour le développement, ou déployé via `npm run build:client` (Port 8080)
- Le serveur, correspondant à l'API Rest exposé par le serveur, qui peut être lancé via `npm run server` (Port 3100)
- L'updater, correspondant au processus mettant à jour les données à intervalle régulié, qui peut être lancé via `npm run schedule`