💻Contribuer

Architecture de haut niveau du cadre principal utilisé dans l'application

L'architecture de la plateforme MEDomics

La carte ci-dessous illustre l'organisation des fichiers, des modules, des bases de données et la connexion Frontend-Backend au sein de la plateforme MEDomics. Ce guide visuel est conçu pour aider les nouveaux contributeurs à comprendre la structure de l'application, à faciliter l'intégration de nouvelles fonctionnalités et à aider à naviguer efficacement dans la base de code.

architecture détaillée de la plateforme MEDomics

Configuré depuis les fondations 🌱

Allez visiter notre branche de développement GitHub!

1. Installation de MongoDB Community Edition

Suivez les instructions d'installation en fonction de votre système d'exploitation pour Installation de MongoDB.

Windows

Installer MongoDB sur Windows

• N'installez pas MongoDB en tant que service.

• Vous n'êtes pas obligé d'installer MongoDB Compass.

• Vous n'êtes pas obligé d'installer mongosh.

• N'oubliez pas de ajouter les binaires MongoDB au PATH système.

Linux

Mac

2. Installation des outils de base de données MongoDB

Suivez les instructions d'installation en fonction de votre système d'exploitation pour Installation des outils de base de données MongoDB.

Windows

Installer les outils de base de données MongoDB sur Windows

• Installez avec l'installateur MSI.

Linux

Mac

1. Installation de Nvm

• NVM pour Windows

• NVM pour Ubuntu

2. Installation de npm/node.js

nvm install lts
nvm use lts

3. Cloner le dépôt

Nous utilisons actuellement develop comme notre branche d'intégration.

HTTPS

git clone -b scalability https://github.com/MEDomics-UdeS/MEDomicsLab.git

SSH

4. Configuration côté serveur (Go)

4.1 Installation de Go

1. Téléchargez la dernière version stable de Go depuis le site officiel : https://golang.org/dl/

2. Suivez les instructions d'installation pour votre système d'exploitation.

4.2 Configuration de l'environnement

Windows

Exécutez ces commandes dans une invite CMD nd :

setx GOPATH %USERPROFILE%\go
setx PATH "%PATH%;C:\Go\bin"

Linux et Mac

Après, fermez tous vos terminaux car ces commandes prendront effet lors de l'initialisation de tout terminal

4.3 Vérifier l'installation

1. Ouvrez un nouveau terminal

2. Exécutez la commande go version

3. Si Go est correctement installé, vous devriez voir le numéro de version affiché dans la console.

4.4 Configuration pour l'application

1. Ouvrez une nouvelle invite de commandes et rendez-vous dans le <repo path>/go_server répertoire.

2. Exécutez la commande go run main.go (la première fois, il devrait télécharger les bibliothèques requises et lancer le serveur)

3. Vous pouvez terminer le processus en appuyant sur CTRL + C

4. Enfin, compilez l'application en exécutant go build main.go (Cela devrait créer un fichier exécutable -> ce fichier sera exécuté par le JavaScript côté client, donc les modifications des .go fichiers doivent être suivies d'une recompilation. Félicitations, vous êtes maintenant prêt à commencer à développer des applications Go !

5. Initialiser les sous-modules

cd <.../MEDomicsLab/>
git checkout dev_lab
cd ../MEDprofiles
git checkout fusion_MEDomicsLab

6. Démarrez l'application Electron !

cd <.../MEDomicsLab>
npm install
npm run dev

Sur Windows, si vous rencontrez des messages d'erreur lors de l'exécution npm installliés aux fichiers .dll manquants de tensorflow, revenez à votre version de node en suivant ces étapes :

• Téléchargez node v18.16.1

• Ajoutez au PATH la voie vers votre nouveau node en la plaçant avant l'ancienne.

• Testez votre version de node en utilisant : node --version

Configuration de MongoDB

La plateforme MEDomicsLab utilise le port 54017 comme port de connexion MongoDB par défaut. Pour la visualisation et la gestion de la base de données, nous recommandons d'utiliser MongoDB Compass, le client GUI officiel de MongoDB.

Détails clés:

• Port par défaut : 54017

• Client recommandé : MongoDB Compass

• Format de la chaîne de connexion : mongodb://localhost:54017/

Modifier les paramètres de démarrage

1. Allez dans le fichier medomics.dev.js

2. Voici une description de l'objet :

const config = {
  // Si vrai, le serveur sera lancé automatiquement lorsque l'application sera démarrée
  runServerAutomatically: true,
  // Si vrai, utiliser les outils de développement React
  useReactDevTools: false,
  // le port par défaut à utiliser pour le serveur, assurez-vous qu'aucun programme ne l'utilise par défaut
  defaultPort: 5000,
  // Soit "FIX" soit "AVAILABLE" (sensible à la casse)
  // FIX 		-­> si defaultPort est utilisé, forcer la terminaison et utiliser defaultPort
  // AVAILABLE 	-> si defaultPort est utilisé, itérer pour trouver le prochain port disponible
  portFindingMethod: PORT_FINDING_METHOD.FIX
}

Pour tester la version de production

Construisez l'application Electron et exécutez la version construite

Windows

npm run build:win                            # construire et empaqueter l'application 
.\build\dist\win-unpacked\MEDomicsLab.exe    # Exécuter l'exécutable de la version construite

Linux

Mac

L'application construite se trouvera dans le build/dist dossier