Slippi Stats Web

De LeFrenchMelee

Slippi Stats Web est un projet visant à visualiser des données extraites depuis les fichiers replays de Slippi (.slp) dans une interface web. Le projet est hébergé sur Gitlab.

Une instance de démonstration est accessible sur https://slippi.mickaelgillot.xyz

Installation

Pré-requis

Il est vivement recommandé d'utiliser Docker et Docker Compose pour installer l'application. En effet, le projet a besoin d'une configuration sur l'environnement pour fonctionner correctement (base de données MySQL, compilateur SCSS, Nodejs, Python, Flask, etc). Cette configuration est automatiquement faite en utilisant Docker et Docker Compose.

Bien entendu, il reste cependant possible de configurer manuellement l'environnement avec toutes ces dépendances pour faire fonctionner Slippi Stats Web.

Installation avec Docker et Docker Compose

Dans un premier temps, il faut récupérer les sources du projet. Pour cela, on peut cloner le dépôt git

$ git clone git@gitlab.com:Coukaratcha/slippi-stats-web.git

ou télécharger une archive du projet ici.

Ensuite, il faut dupliquer le fichier production.env.sample pour production.env et renseigner quelques variables spécifiques à votre instance.

D'abord il faut choisir ou, mieux, générer trois mots de passe (avec un générateur de mot de passe comme ici ou ) et affecter ces mots de passe aux variables MYSQL_ROOT_PASSWORD, MYSQL_PASSWORD et SECRET_KEY.

Ensuite, entrez votre code joueur Slippi dans PLAYER_CODE. Il devrait ressembler à XXXX#123.

Maintenant, la configuration est terminée. Il reste à créer 2 répertoires à la racine du projet :

  • data/ : C'est le répertoire qui contiendra les fichiers de la base de données qui sera créé et permettra de persister les données après l'arrêt de Slippi Stats Web.
  • replays/ : C'est le répertoire qui contiendra les fichiers replays .slp qui seront analysés par Slippi Stats Web. Après démarrage du service, ce répertoire sera automatiquement examiné toutes les 15mn.

Voilà, tout est prêt !

Vous pouvez donc lancer le service avec la commande suivante :

$ docker-compose up -d

Une fois la commande terminée, vous devriez pouvoir accéder à l'interface web en ouvrant un navigateur web puis en vous rendant sur http://localhost:5000.