¶ Travailler avec GitHub localement sur votre PC
Cette solution pour travailler sur GitHub est beaucoup plus complexe que l’option précédente expliquée dans ce manuel, travaillez directement depuis le site Web GitHub. Pour cette raison, il n’est recommandé qu’aux utilisateurs ayant une certaine connaissance de Git et GitHub. Il s’agit d’une option beaucoup plus flexible et puissante qui nous permet d’éditer Urantiapedia de manière plus rapide et plus approfondie. De plus, il vous permet d’exécuter des outils, appelés Urantiapedia Tools, qui effectuent des tâches automatisées très rapides.
Cela devrait être l’option la plus recommandée pour les utilisateurs Administrateurs ou Rédacteurs en chef, tandis que l’option permettant de travailler directement à partir du site Web GitHub est recommandée pour les utilisateurs Rédacteurs adjoints.
La première chose pour travailler localement sur GitHub est d’effectuer plusieurs installations logicielles que nous allons vous expliquer. Ensuite nous donnerons quelques conseils de configuration.
Il est supposé qu’avant de suivre ces étapes, nous avons déjà créé un compte sur GitHub et avons fait les copies (forks) nécessaires des projets Urantiapedia dans notre compte, comme détaillé dans Premiers pas sur GitHub.
¶ Installez Git sur votre PC
- Accédez à https://git-scm.com/.
- Téléchargez le programme d’installation de votre système d’exploitation. Vous disposez d’un didacticiel complet sur la façon de l’installer sur différents systèmes d’exploitation ici : Installer Git. Sous Windows, utilisez le programme d’installation et laissez les options par défaut.
- Vérifiez que Git est correctement installé en exécutant ceci dans un terminal :
git --version. S’il renvoie le numéro de version, alors Git est correct. - Exécutez les commandes suivantes dans un terminal (Git installe un terminal appelé Git CMD que vous pouvez utiliser) pour configurer votre identité dans Git, avec votre nom et votre email. Ceci est requis pour que Git vous configure en tant que contributeur de code.
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
¶ Installez Node.js sur votre PC
Node.js est une condition requise pour faire fonctionner les Urantiapedia Tools. Si vous ne comptez pas les exécuter, vous ne pouvez jamais sauter cette étape, même si elle est recommandée.
- Accédez à https://nodejs.org/.
- Téléchargez Node.js. Utilisez la version LTS actuelle disponible.
- Installez avec les options par défaut.
- Vérifiez que Node.js est correctement installé. Ouvrez un terminal et exécutez
node -v. Si le numéro de version apparaît, alors Node.js est correct.
¶ Installer VS Code et GitLens
L’utilisation de Visual Studio Code est fortement recommandée.
- Accédez à https://code.visualstudio.com/.
- Téléchargez-le et installez-le. Lors de l’installation, il est conseillé de cocher l’option “Ajouter l’action ‘Ouvrir avec code’ au menu contextuel des répertoires” si vous êtes un utilisateur Windows.
- Ouvrez-le. La première fois qu’il s’ouvre, vous pouvez définir certaines options. Ignorez-les.
- Dans VS Code, cliquez sur le bouton Extensions sur le panneau de boutons de gauche. Il est fortement recommandé d’installer une extension appelée « GitLens ». Elle figure généralement sur la liste des extensions les plus populaires. Localisez-le et cliquez sur le bouton d’installation.
- Vous aurez désormais un nouveau bouton pour GitLens dans le panneau de boutons de gauche de VS Code. Cliquez dessus et cliquez sur le bouton Welcome (Quick setup). La page Welcome s’ouvre. Il est recommandé de sélectionner Source control layout comme vue par défaut. Cela provoque la fusion de GitLens avec le panneau Source control par défaut de VS Code.
¶ Cloner des projets Urantiapedia
- Ouvrez le site Web GitHub et accédez à votre compte.
- Ouvrez vos copies des projets Urantiapedia (forks) que vous auriez dû créer.
- Sur la page principale de chaque copie, cliquez sur le menu vert appelé Code et cliquez dessus pour copier l’URL du projet, quelque chose comme
https://github.com/<username>/urantiapedia.gitethttps:/ /github.com/<username>/urantiapedia-backup.git.
- Ouvrez VS Code, ouvrez le panneau Source control et cliquez sur Clone repository.
- Dans la zone de texte qui apparaît, saisissez ou collez le chemin copié précédemment.
- Sélectionnez Clone from GitHub.
- Cliquez sur Allow in the GitHub extension to sign in.
- Une page Web apparaît demandant l’autorisation de VS Code pour accéder à GitHub. Cliquez sur Continue.
- Cliquez sur Authorize github.
- Vous êtes maintenant redirigé vers une nouvelle page Web où un message s’ouvre. Cliquez sur Open VS Code.
- Cliquez maintenant sur Open pour autoriser l’utilisation du chemin fourni. Si quelque chose ne va pas, répétez à partir du point 4.
- Lorsque le nom du référentiel de votre projet Urantiapedia est affiché dans le centre de commande, sélectionnez-le. Une boîte de dialogue apparaîtra demandant un dossier. Sélectionnez n’importe quel dossier ou créez-en un pour le projet.
- Attendez quelques minutes que VS Code clone le référentiel. Cliquez enfin sur Open repo. Cliquez également sur Yes, I trust the authors.
- Le projet s’ouvrira avec succès.
- Effectuez ces mêmes étapes pour chaque projet, pour urantiapedia et pour urantiapedia-backup.
¶ Configurer les Urantiapedia Tools
Les Urantiapedia Tools sont une application de bureau développée en JavaScript avec Electron. Il est utilisé pour exécuter des processus très rapides qui modifient des centaines de pages à la fois. Si vous n’en avez pas besoin, vous pouvez ignorer cette étape. Pour l’installer et l’exécuter, suivez ces étapes :
- Ouvrez le projet urantiapedia dans VS Code. Pour ce faire, vous pouvez le faire de deux manières :
- Ouvrir VS Code. Sélectionnez File > Open folder. Sélectionnez le dossier racine du projet, celui qui contient le fichier
package.json. - En option, sous Windows, vous pouvez ouvrir le projet en utilisant le menu contextuel du dossier racine et sélectionner Ouvrir avec Code.
- Ouvrez un terminal en utilisant Terminal > New Terminal. Assurez-vous que le terminal est ouvert dans le dossier racine du projet.
- Pour installer les dépendances des Urantiapedia Tools, exécutez :
npm install. Attendez qu’ils soient tous installés.
- Le projet est configuré avec une configuration d’exécution par défaut. Appuyez sur F5 pour exécuter l’application ou dans le terminal, exécutez « npm run start ».
- L’application s’ouvre. Par défaut, une fenêtre Dev Tools s’ouvre pour pouvoir déboguer. Si vous ne développez pas, vous pouvez l’ignorer ou le fermer.
¶ Liens externes
- Urantiapedia Tools - Projet GitHub
- Urantiapedia-backup - Projet GitHub
- Fondation Urantia
- Blue Fields
- Wiki.js