diff --git a/README.md b/README.md index 75a8207..4143d61 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,22 @@ sudo apt install libssl-dev `.env` placé dans la racine du projet qui contient ses différentes variables : ``` -TOKEN_MATTERMOST=votre_token_ici # pas besoin de token si vous mettez un combo pseudo/mot-de-passe -PSEUDO=votre_pseudo_ici # pas besoin de pseudo si un token est renseigné -MOT_DE_PASSE=votre_mot-de-passe_ici # pas besoin de mot de passe si un token est renseigné -URL=url_du_site_ici # ex: https://talk.up8.edu -EQUIPE=nom_de_lequipe # ex: etudiant-es -SALON=nom_du_salon # ex: off-topic +TOKEN_MATTERMOST=votre_token_ici # OBLIGATOIRE? | Pas besoin de token si vous mettez un combo pseudo/mot-de-passe +PSEUDO=votre_pseudo_ici # OBLIGATOIRE? | Pas besoin de pseudo si un token est renseigné +MOT_DE_PASSE=votre_mot-de-passe_ici # OBLIGATOIRE? | Pas besoin de mot de passe si un token est renseigné + # -> Si les 2 méthode de connexion pour Mattermost sont renseignées (token et pseudo/mot-de-passe), le bot ne se lancera pas. +URL=url_instance_mattermost_ici # OBLIGATOIRE | Ex: https://talk.up8.edu +SALON=nom_du_salon # OBLIGATOIRE | Ex: off-topic +EQUIPE=nom_de_lequipe # FACULTATIF | Ex: etudiant-es + # -> Va permettre d'afficher les informations d'une équipe à chaque démarrage du bot. -TOKEN_DISCORD=votre_token_ici # token discord +TOKEN_DISCORD=votre_token_ici # OBLIGATOIRE | Token Discord -PREFIX=votre_prefix_ici # commun aux deux bots, par défaut: ç +PREFIX=votre_prefix_ici # OBLIGATOIRE | Commun aux deux bots, par défaut: `ç` ``` -*Note: Si les deux moyens de connexion pour Mattermost sont renseignés (token et pseudo/mot-de-passe), le bot ne se lancera pas.* +--- +### Intégrations #### Mattermost Dans le cas ou vous optez pour le token, vous devez ajouter un bot, pour ce faire (d'après la [documentation officielle](https://developers.mattermost.com/integrate/admin-guide/admin-bot-accounts/)) : - Cliquez sur les 9 carrés en haut à gauche @@ -39,7 +42,7 @@ Dans le cas ou vous optez pour le token, vous devez ajouter un bot, pour ce fair - Dans la page suivante, vous aurez votre token d'accès #### Discord - +Pour obtenir un token pour le bot Discord, il y a ce [tuto fait pour la librairie Javascript](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot) qui explique bien. --- ### Tests en local @@ -58,9 +61,9 @@ services: --- ### Sources - [Documentation `mattermost_api`](https://docs.rs/mattermost_api/0.1.0/mattermost_api/) (utilisé pour communiquer avec Mattermost) -- `serde` (utilisé pour ma structure de salon [j'ai fait comme `mattermost_api`]) -- `serde_json` (utilisé pour gérer tout ce qui est `json`) - `tokio` (utilisé car `mattermost_api` est `async`) +- `serde` (utilisé pour ma structure de salon [j'ai fait comme `mattermost_api`]) +- `serde_json` (utilisé pour gérer le format `json`) - [Documentation `chrono`](https://rust-lang-nursery.github.io/rust-cookbook/datetime/parse.html) (utilisé pour l'analyse des timestamps) - [Documentation `serenity`](https://docs.rs/serenity/latest/serenity/client/trait.EventHandler.html) (utilisé pour communiquer avec Discord) - Je me suis aidé de mes [réponses aux rustlings](https://code.up8.edu/Anri/2021-rustlings/-/tree/reponses/exercises) pour me rafraîchir la mémoire sur certains points @@ -78,6 +81,7 @@ Executed in 53.25 secs fish external sys time 19.56 secs 149.00 micros 19.56 secs ``` +--- ### Résumé Beaucoup de blabla, au final, qu'est ce qui fonctionne ? @@ -89,7 +93,16 @@ Beaucoup de blabla, au final, qu'est ce qui fonctionne ? Cependant, je pense avoir fait 50% du travail pour le pont Mattermost, il manque, je pense, une implémentation du websocket de la part du [responsable de `mattermost_api`](https://github.com/Celeo). J'ai essayé de le faire moi-même mais pas réussi. -# Exécution +--- +### Exécution + +``` +git clone git@code.up8.edu:Anri/matter_bot.git matter_bot_akennel +cd matter_bot_akennel +# Créez et complétez le .env +cargo run +``` +
Exemple d'utilisation de matter_bot