https://github.com/99noah99/flashmind
Web application that generates flashcards with AI for import into the Anki application
https://github.com/99noah99/flashmind
docker inertiajs laravel ollama prismphp react
Last synced: 2 months ago
JSON representation
Web application that generates flashcards with AI for import into the Anki application
- Host: GitHub
- URL: https://github.com/99noah99/flashmind
- Owner: 99Noah99
- Created: 2025-04-24T21:53:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-05T20:47:04.000Z (about 1 year ago)
- Last Synced: 2025-05-07T06:49:44.806Z (about 1 year ago)
- Topics: docker, inertiajs, laravel, ollama, prismphp, react
- Language: PHP
- Homepage:
- Size: 312 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 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** :
```bash
git clone https://github.com/votre-utilisateur/FlashMind.git
cd FlashMind
```
2. **Mise ne place .env laravel** :
```bash
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é :
```bash
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 :
```bash
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):
```bash
cd laravel/
php artisan key:generate
```
6. **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.