fabriquedoc/README.md

# Documentation de la fabrique à documents

## Vidéo d'introduction du projet

Comment j'ai construit l'application et comment la personnaliser: https://videos.jevalide.ca/w/1jCGoaTpQoUGAWFwpGv3Qw

## Nouveautés

- 17 mai 2023: <https://videos.jevalide.ca/w/1KBBuYz6BuJ9yEhukDob2G>

## Utilisation avec Docker Desktop

### Prérequis

#### Windows
- Windows Subsystem for Linux (WSL)
- Docker Desktop
- Visual Studio Code
- Git for Windows

#### macOS
- Docker Desktop
- Visual Studio Code
- Homebrew (pour installer Git)

### Installation des prérequis

#### Windows

1. Installer Windows Subsystem for Linux (WSL):
   - Ouvrir un invite de commandes en tant qu'administrateur
   - Exécuter: `wsl.exe --update`

2. Installer Docker Desktop:
   - Télécharger depuis: https://www.docker.com/products/docker-desktop/
   - Installer et redémarrer l'ordinateur

3. Installer Visual Studio Code:
   - Télécharger depuis: https://code.visualstudio.com/
   - Installer et ouvrir l'application
   - Installer l'extension Docker

4. Installer Git for Windows:
   - Suivre les instructions d'installation par défaut
   - Choisir Visual Studio Code comme éditeur par défaut
   - Choisir "Override the default branch for new repositories"

#### macOS

1. Installer Docker Desktop:
   - Télécharger depuis: https://www.docker.com/products/docker-desktop/
   - Installer et redémarrer l'ordinateur

2. Installer Visual Studio Code:
   - Télécharger depuis: https://code.visualstudio.com/
   - Installer et ouvrir l'application
   - Installer l'extension Docker

3. Installer Homebrew et Git:
   - Ouvrir Terminal
   - Installer Homebrew en suivant les instructions sur https://brew.sh
   - Installer Git: `brew install git`

### Configuration du projet

1. Cloner le dépôt:
   - Ouvrir Visual Studio Code
   - Utiliser la commande "Clone Repository"
   - Entrer l'URL: https://git.jevalide.ca/gitlab/partage/fabriquedoc.git

2. Configuration:
   - Copier le fichier `.env.example` et le renommer en `.env`
   - Modifier les variables dans `.env` selon vos besoins

3. Lancer l'application:
   - Ouvrir un terminal dans Visual Studio Code
   - Exécuter: `docker-compose --env-file .env up --build`

L'application sera disponible à l'adresse: http://localhost:8051/

### Utilisation de scripts

Pour simplifier le lancement et l'arrêt de l'application, vous pouvez utiliser les scripts fournis:

#### Windows (PowerShell)

- Pour lancer: `.\run_docker_compose.ps1`
- Pour arrêter: `.\stop_docker_compose.ps1`

#### macOS/Linux (Bash)

- Pour lancer: `./run_docker_compose.sh`
- Pour arrêter: `./stop_docker_compose.sh`

Ces scripts vérifient les prérequis, lancent l'application avec la configuration appropriée, et gèrent l'arrêt propre de l'application.

## Développement

Pour le développement local, assurez-vous d'utiliser le fichier `docker-compose-local.yml` qui expose les ports nécessaires sur localhost.

## Support

Si vous rencontrez des problèmes ou avez des questions, n'hésitez pas à me contacter via mon formulaire de contact au <https://jevalide.ca>