diff --git a/README.md b/README.md index 7910cbd..230e12b 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,16 @@ # libere-tes-chaine-de-mots -![screenshot-lcm-demo001.png](images/screenshot-lcm-demo001.png) - Je te présente Libère tes chaînes de mots, mon nouveau projet de moteur de recherche de publications sur les médias sociaux et autres plateformes web. -Ce logiciel est construit avec le moteur de recherche OpenSearch et du code Python et R. Je réutilise du code de mon ancien projet Libère tes chaînes de mots, que j'avais lancé il y a 2 ans. +Ce logiciel est construit avec le moteur de recherche TypeSense et du code Python. Je réutilise du code de mon ancien projet Libère tes chaînes de mots, que j'avais lancé il y a 2 ans. Il permet d'explorer nos données de publications exportées depuis les plateformes. Actuellement LinkedIn, Facebook, Instagram et Wordpress sont supportés. D'autres plateformes viendront sous peu dont les podcasts en RSS, Threads et les infolettres. - - -- Vidéo démo disponible ici: https://videos.jevalide.ca/w/civfiTK5RQiEYLoMhonWPV +- Ancien vidéo démo disponible ici: https://videos.jevalide.ca/w/civfiTK5RQiEYLoMhonWPV - Code disponible ici: https://git.jevalide.ca/lcm/libere-tes-chaine-de-mots (tu es ici en ce moment) -- Soutien disponible en mode consultation express: https://jevalide.ca/express +- Soutien disponible pour installation et configuration en mode consultation express: https://jevalide.ca/express # Installation @@ -27,7 +23,6 @@ Pour utiliser cet outil, tu as besoin d'installer des logiciels, d'obtenir tes d - [Homebrew sur MacOS](https://brew.sh/) pour installer des trucs (si tu l'as pas déjà t'as manqué de quoi !) - Git (Installer avec Homebrew sur Mac, [Git Bash](https://git-scm.com/downloads) sur Windows) - Python (Installer avec Homebrew sur Mac, [Site officiel Python](https://www.python.org/downloads/windows/) sur Windows) -- R (pour commentaires LinkedIn seulement) - Un IDE tel que [Visual Studio Code](https://code.visualstudio.com/) ou [IntelliJ IDEA](https://www.jetbrains.com/idea/) ## Obtenir les données @@ -39,7 +34,6 @@ Tu peux obtenir une sauvegarde des données de tes réseaux sociaux. Je t'ai mis - [Demander les fichiers de données pour le profil LinkedIn](demander_donnees/demander_linkedin.pdf) - [Extraire les fichiers de données pour le profil LinkedIn](demander_donnees/extraire_linkedin.pdf) - ### Instagram - [Demander tes données de Facebook et Instagram](demander_donnees/demander_facebook_instagram.pdf) @@ -58,10 +52,10 @@ Tu peux obtenir une sauvegarde des données de tes réseaux sociaux. Je t'ai mis ## Cloner le projet et initialiser le moteur de recherche - Clone le projet avec Git -- Configure ton mot de passe en copiant .env.template dans .env et en y mettant un mot de passe de ton choix -- Exécute le fichier docker-compose.yml avec Docker Compose pour installer le moteur de recherche OpenSearch -- Connecte toi à OpenSearch Dashboards au http://localhost:5601 avec l'utilisateur `admin` et le mot de passe que tu as choisi ci-dessus -- Si tout fonctionne, tu vas accéder à l'interface +- Configure ta clé API en copiant `.env.template` dans `.env` et en y mettant une clé API de ton choix +- Exécute le fichier `docker-compose.yml` avec Docker Compose pour installer le moteur de recherche TypeSense +- Connecte-toi à l'application en lançant run_streamlit_app.py et en allant au http://localhost:8501 +- Si tout fonctionne, tu vas accéder à l'interface de recherche ## Mettre les fichiers au bon endroit @@ -71,12 +65,4 @@ Tu peux obtenir une sauvegarde des données de tes réseaux sociaux. Je t'ai mis ![ou-mettre-fichiers-reseaux.png](images/ou-mettre-fichiers-reseaux.png) - Exécuter le fichier qui crée les index dans le moteur de recherche [00_creer_reseauxsociaux.py](import_data/00_creer_reseauxsociaux.py) -- Ensuite exécuter tous les fichiers Python pertinents pour charger les données que tu as téléchargées. - -Ensuite, tu devrais pouvoir voir toutes les données que tu as chargées dans OpenSearch Dashboards sur http://localhost:5601. Va dans Discover / Search and find insights. - -![opensearch-discover.png](images/opensearch-discover.png) - -Ensuite change la plage de temps pour voir les données - -![opensearch-changer-plage-temps.png](images/opensearch-changer-plage-temps.png) \ No newline at end of file +- Ensuite exécuter tous les fichiers Python pertinents pour charger les données que tu as téléchargées. Tu peux aussi utiliser [run_all_imports.sh](import_data/run_all_imports.sh). \ No newline at end of file