Melodistrib

Sommaire

• Sommaire
• Installation
• Utilisation
  • 🎵 Saisie des morceaux (1/4)
    • ➕ Ajouter un morceau
    • 📝 Modifier ou supprimer un morceau
    • 🔄 Importer et exporter des morceaux
    • 🗑️ Supprimer tous les morceaux
    • 📌 Fonctionnalités pratiques
  • 🎵 Saisie des musiciens (2/4)
    • ➕ Ajouter un musicien
    • 📝 Modifier ou supprimer un musicien
    • 🔄 Importer et exporter des musiciens
    • 🗑️ Supprimer tous les musiciens
    • 📌 Fonctionnalités pratiques
  • 🎶 Sélection des morceaux (3/4)
    • 👥 Choisir un musicien
    • 📊 Importer et exporter les sélections
    • 🔄 Remettre à zéro
    • 🔎 Fonctionnalités pratiques
  • 🎶 Répartition des musiciens (4/4)
    • 👥 Générer un enchaînement
    • 📊 Importer et exporter des données
    • 🔎 Fonctionnalités
  • Technologies utilisées
  • Recommandations de développement
  • Développement
    • Installation des dépendances
    • Démarrage en mode développement
    • Builder le logiciel avec Electron-Builder
      • Pour Windows/Mac/Linux
• Contribuer à Mélodistrib
  • Soumettre des problèmes
  • Contribuer au code
• Licence

Mélodistrib est un logiciel innovant conçu pour répartir équitablement des musiciens parmi une liste prédéfinie de morceaux, tout en optimisant l'enchaînement des morceaux pour minimiser les déplacements des artistes entre chaque morceau. Ce document fournit des informations détaillées sur l'installation, l'utilisation et le développement du logiciel.

Installation

Pour installer Mélodistrib, suivez ces étapes simples :

1. Téléchargez le fichier d'installation depuis la section Releases du dépot GitHub ou en cliquant ici.
2. Exécutez le fichier .exe téléchargé.
3. Le logiciel s'installera selon vos préférences, créera une icône sur le bureau et s'ouvrira automatiquement.

Utilisation

🎵 Saisie des morceaux (1/4)

Sur cette première page, Saisie des morceaux, il est possible d’entrer la liste des morceaux qui seront joués 🎶.

➕ Ajouter un morceau

Cliquer sur le bouton Ajouter 🔵 pour ajouter un morceau. Une fenêtre s’ouvrira afin de renseigner :

• Le nom du morceau 🎼
• Le nombre maximal de musiciens pouvant jouer ce morceau 🎻🎺🥁

📝 Modifier ou supprimer un morceau

Lors du survol d’une carte de morceau avec la souris 🖱️, deux boutons apparaissent :

• ✏️ Éditer : Permet de modifier les informations du morceau.
• 🗑️ Supprimer : Permet de retirer le morceau de la liste.

🔄 Importer et exporter des morceaux

• 💾 Exporter : Sauvegarde la liste des morceaux dans un fichier .melt2 📁.
• 📂 Importer : Charge une liste de morceaux à partir d’un fichier .melt2.
• 🎭 Importer des sélections : Permet d’importer un fichier .mels2 contenant les morceaux, les musiciens et leurs sélections.
• 🔗 Importer un enchaînement : Charge un enchaînement de morceaux préalablement conçu avec Melodistrib (.meld2) contenant toutes les données.

🗑️ Supprimer tous les morceaux

Le bouton Tout supprimer 🛑 efface l’intégralité de la liste des morceaux. ⚠️ Action irréversible !

📌 Fonctionnalités pratiques

• 🧐 Chercher un morceau : Utiliser la barre de recherche pour retrouver rapidement un morceau.

Une fois la liste prête, cliquer sur Suivant 🔵 pour passer à l’étape suivante : Saisie des musiciens 👥.

🎵 Saisie des musiciens (2/4)

Sur cette deuxième page, Saisie des musiciens, il est possible d'entrer la liste des musiciens participants 🎶.

➕ Ajouter un musicien

Cliquer sur le bouton Ajouter 🔵 pour ajouter un musicien. Une fenêtre s’ouvrira afin de renseigner :

• Nom 🏷️
• Prénom 👤

📝 Modifier ou supprimer un musicien

Lors du survol d’une carte de musicien avec la souris 🖱️, deux boutons apparaissent :

• ✏️ Éditer : Permet de modifier les informations du musicien.
• 🗑️ Supprimer : Permet de retirer le musicien de la liste.

🔄 Importer et exporter des musiciens

• 💾 Exporter : Sauvegarde la liste des musiciens dans un fichier .melm2 📁.
• 📂 Importer : Charge une liste de musiciens à partir d’un fichier .melm2.
• 🎭 Importer des sélections : Permet d’importer un fichier .mels2 contenant musiciens, morceaux et leurs sélections.
• 🔗 Importer un enchaînement : Charge un enchaînement de morceaux préalablement conçu avec Melodistrib (.meld2).

🗑️ Supprimer tous les musiciens

Le bouton Tout supprimer 🛑 efface l'intégralité de la liste des musiciens. ⚠️ Action irréversible !

📌 Fonctionnalités pratiques

• 🧐 Chercher un musicien : Utiliser la barre de recherche pour retrouver rapidement un musicien.

Une fois la liste prête, cliquer sur Suivant 🔵 pour passer à l’étape suivante : Sélection des morceaux 🎭.

🎶 Sélection des morceaux (3/4)

Sur cette page, Sélection des morceaux, il est possible d'attribuer des morceaux aux musiciens 🎻. Cela permet de gérer facilement les préférences de chacun au sein du groupe.

👥 Choisir un musicien

Cliquer sur un musicien dans la liste pour lui attribuer ses morceaux ✨. Une fenêtre s’ouvrira, affichant tous les morceaux disponibles 📜. Il sera alors possible de sélectionner ceux que ce musicien souhaite jouer en utilisant les cases à cocher.

📊 Importer et exporter les sélections

• 💾 Exporter les sélections : Sauvegarde les sélections de morceaux effectuées par les musiciens dans un fichier .mels2 📁.
• 📂 Importer les sélections : Charge une les sélections de morceaux effectuées par les musiciens depuis un fichier .mels2 préparé au préalable.
• 🔗 Importer l’enchaînement : Permet d’importer un enchaînement de morceaux créé précédemment avec Melodistrib (.meld2).

🔄 Remettre à zéro

Pour réinitialiser l’ensemble des sélections, utiliser le bouton Tout remettre à zéro 🔴. ⚠️ Action irréversible : cette opération effacera toutes les sélections effectuées pour chaque musicien.

🔎 Fonctionnalités pratiques

• 🧭 Chercher un musicien : Utiliser la barre de recherche pour retrouver rapidement un musicien spécifique.
• 📋 Voir la répartition : Cliquer sur Voir la répartition pour obtenir un aperçu de la distribution des morceaux choisis parmi tous les musiciens.

Une fois les sélections terminées, cliquer sur Suivant 🔵 pour passer à l’étape suivante : Répartition des musiciens 📈.

🎶 Répartition des musiciens (4/4)

Sur cette page, Répartition des musiciens, il est possible de générer et de modifier facilement la répartition des musiciens, sans avoir à exporter l'enchaînement dans un fichier Word au préalable 🎻.

👥 Générer un enchaînement

Pour générer un enchaînement, il suffit de cliquer sur le bouton Générer.

📊 Importer et exporter des données

• 💾 Exporter l'enchaînement : Sauvegarde les enchaînements de morceaux et la répartition des musiciens dans un fichier .meld2 📁.
• 📂 Importer l'enchaînement : Charge un enchaînement de morceaux et la répartition des musiciens depuis un fichier .meld2 📁.
• 🔗 Exporter sous Word : Génère un fichier Word récapitulatif de l'enchaînement (.docx).

🔎 Fonctionnalités

• 🧭 Générer un enchaînement : Cliquer sur le bouton Générer pour créer automatiquement un nouvel enchaînement.
• ⚙️ Paramétrer un enchaînement : L'icône engrenage située à côté du bouton Générer permet de modifier certains paramètres (forcer l'assignation d'un musicien, mélanger les morceaux avant la répartition ou encore choisir le premier morceau à jouer).
• 📋 Optimiser l'ordre : Si l'attribution des musiciens à un ou plusieurs morceaux a été modifiée, il est conseillé de cliquer sur le bouton Optimiser l'ordre afin de minimiser les déplacements durant le concert.
• 🔀 Changer l'ordre manuellement : Il est possible de réorganiser l'ordre des morceaux en effectuant un glisser-déposer dans la liste affichée.
• ❌ Supprimer : Permet de retirer rapidement un musicien d'un morceau.
• ➕ Ajouter : Permet d'ajouter un musicien à un morceau.

Technologies utilisées

Mélodistrib a été développé en utilisant les technologies suivantes :

Recommandations de développement

Pour contribuer au développement de Mélodistrib, suivez ces recommandations :

• Éditeur: VSCode
• Outils: ESLint, Prettier, Volar

Développement

Installation des dépendances

$ npm install

Démarrage en mode développement

$ npm run dev

Builder le logiciel avec Electron-Builder

Pour Windows/Mac/Linux

$ npm run build

---

Note: Assurez-vous d'avoir Node.js installé sur votre système avant de suivre ces étapes.

Contribuer à Mélodistrib

Si vous souhaitez contribuer, suivez ces étapes :

Soumettre des problèmes

Si vous rencontrez des problèmes ou avez des idées d'amélioration, veuillez les soumettre sur la page "Issues" du référentiel GitHub en cliquant ici. Assurez-vous de fournir des informations détaillées sur le problème rencontré ou la fonctionnalité proposée.

Contribuer au code

1. Fork du référentiel : Commencez par forker le référentiel Mélodistrib sur GitHub.

2. Clone du fork : Clonez votre fork sur votre machine locale.

   git clone https://github.com/<votre-pseudo>/melodistrib.git

3. Création d'une branche : Créez une branche pour travailler sur votre contribution.

   git checkout -b nom-de-ma-branche

4. Installation des dépendances : Assurez-vous d'avoir les dépendances nécessaires installées.

   npm install

5. Effectuer des modifications : Faites les modifications nécessaires et testez-les localement.

6. Validation des modifications : Assurez-vous que votre code respecte les recommandations de Prettier.

   npm run format

7. Soumettre les modifications : Une fois vos modifications testées, effectuez un commit et poussez-les sur votre fork.

   git commit -m "Description des modifications"
   git push origin nom-de-ma-branche

8. Création d'une pull request : Sur la page GitHub de votre fork, créez une pull request en sélectionnant la branche que vous venez de pousser.

Mélodistrib simplifie le processus de planification musicale en répartissant intelligemment les musiciens et en optimisant l'enchaînement des morceaux. Profitez de cette solution intuitive et gagnez du temps dans l'organisation de vos événements musicaux !

Licence

Mélodistrib est sous licence GPLv3 - voir le fichier LICENSE pour plus de détails.

Logiciel créé et développé par Zoliex