Skip to content

Web application that generates flashcards with AI for import into the Anki application

Notifications You must be signed in to change notification settings

99Noah99/FlashMind

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 

Repository files navigation

FlashMind - Application de génération de Flashcards

FlashMind est une application qui permet de générer des flashcards à partir de documents ou de textes. Ces flashcards peuvent ensuite être exportées au format CSV pour être importées dans des applications comme Anki.

Fonctionnalités :

  • Analyse de texte : Envoie un texte ou un document et gĂ©nère des flashcards automatiquement.
  • Export en CSV : Exportez les flashcards gĂ©nĂ©rĂ©es au format CSV pour les importer facilement dans Anki.
  • Interface front-end : Utilise React avec Inertia.js pour une expĂ©rience utilisateur fluide et moderne.
  • Utilisation de Laravel : Laravel est utilisĂ© pour la logique back-end, avec une architecture propre et Ă©volutive.
  • Architecture DockerisĂ©e : Le projet utilise Docker pour faciliter la mise en place de l'environnement de dĂ©veloppement.

🚀 Mise en place du projet

Prérequis :

  • Docker et Docker Compose installĂ©s sur votre machine.
  • WSL 2 (Windows Subsystem for Linux) sur Windows si vous utilisez Windows sinon linux.

Étapes pour lancer le projet :

  1. Cloner le projet depuis GitHub :

    git clone https://github.com/votre-utilisateur/FlashMind.git
    cd FlashMind
  2. Mise ne place .env laravel :

    cd laravel/
    cp .env.example .env
  3. Vérification de Docker et Docker Compose :

    • Avant de continuer, assurez-vous que Docker fonctionne bien et que Docker Compose est installĂ© :
      docker --version
      docker-compose --version
  4. Lancer les conteneurs Docker :

    • Assurez-vous que Docker est en cours d'exĂ©cution, puis lancez les services avec Docker Compose :
      docker-compose up -d
      Cela va télécharger les images nécessaires et démarrer les conteneurs pour Laravel, Node.js (pour Vite), Nginx, et Ollama.
  5. Générer la key laravel :

  • Assurez-vous que Docker a bien fini de crĂ©er le dossier /vendor de laravel (cela peut prendre du temps):
    cd laravel/
    php artisan key:generate
  1. Accéder à l'application dans le navigateur :
    • Nginx (Laravel) : AccĂ©dez Ă  l'application Laravel via http://localhost:8080 --> peut prendre du temps pour la première requete.

About

Web application that generates flashcards with AI for import into the Anki application

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published