La documentation de MathALÉA est séparée en deux parties :
- Vous êtes actuellement dans la partie qui comporte différents tutoriels écrits par la communauté et conçus pour vous aider à développer des exercices sur MathALÉA ;
- Il y en a une autre générée automatiquement à partir des commentaires du code (JSCode) qui détaille les différentes classes et fonctions existantes :
- pour la documentation ne concernant que le contenu mathalea2D : https://coopmaths.fr/documentation/2d/,
- Pour la documentation ne concernant que la 3D : https://coopmaths.fr/documentation/3d/,
- pour la documentation ne concernant que mathaleaInstrumenpoche : https://coopmaths.fr/documentation/instrumenpoche/
- pour la documentation des outils : https://coopmaths.fr/documentation/outils/,
- pour les autres fonctions : https://coopmaths.fr/documentation/tout/,
Si vous avez besoin d'une fonction particulière lorsque vous créez un exercice, vous pouvez jeter un œil à ces documentations pour voir si elle n'a pas déjà été créée.
Différents tutoriels sont accessibles via le panneau de droite : n'hésitez pas à les consulter.
Guide de première installation
Le but de ce guide n'est pas de vous guider pas à pas mais de vous faire éviter tous les écueils. Il vous aiguillera à chaque "intersection" mais supposera que vous serez capables de vous en sortir à chaque "ligne droite" comme par exemple que vous serez capables de cliquer sur "suivant" lors des installations (même si c'est écrit en anglais !).
Par contre, il est important que vous suiviez chacune de ces étapes, car si vous en oubliez une, vous serez certainement bloqué par une erreur par la suite.
Le corollaire étant, si vous êtes bloqué par une erreur, passez en revue les points précédents pour vérifier si vous avez bien tout fait.
Installation des logiciels
- Commencer par se créer un compte sur https://forge.apps.education.fr/users/sign_up puis le communiquer à Rémi Angot pour obtenir des droits d'écriture (sauf sur la branche main qui est protégée pour tout le monde). Vous n'avez pas à attendre qu'il le fasse pour faire la suite, alors c'est parti !
- InstallerVisual Studio Code (ou VSCodium si vous êtes plus débrouillard et voulez une installation sans aucune trace de Microsoft), appelés VSC par la suite.
-
Installer NodeJS :
- Pour Windows et MacOS (la version LTS).
- Pour Linux, vous trouverez les instructions d'installation ici https://github.com/nodesource/distributions/blob/master/README.md
-
Installer Git :
- Pour Windows.
- Pour MacOS :
- Commencer par ouvrir un terminal (cliquer sur le LaunchPad et rechercher
Terminal
). - Commencer par installer Homebrew si ce n'est pas déjà fait
- Puis installer Git en copiant-collant cette commande :
brew install git
- Commencer par ouvrir un terminal (cliquer sur le LaunchPad et rechercher
- Pour Linux, saisir
sudo apt-get install git
dans un terminal (pour les distributions basées sur Debian comme Ubuntu).
Paramétrer l'authentification
- Installer l’extension GitLab Workflow extension dans Visual Studio (en cliquant sur
install
et en acceptant la demande du navigateur, vous pouvez directement ouvrir VSC et installer cette extension) -
Control + Shift + P
(ouCommand + Shift + P
) pour ouvrir la palette de commandes - Chercher
gitlab
et cliquer surGitLab: Authenticate
- Cliquer sur
Manually enter instance URL
- Saisir ou coller
https://forge.apps.education.fr/
- Cliquer sur
Create a token first
puis surOpen
- Paramétrer une date d’expiration ou son absence (la procédure sera à renouveler à l’expiration).
- Sélectionner les portées : Tout cocher
- Cliquer sur "Create personal access token" / "Créer un(e) jeton d'accès personnel"
- Copier le code
- Retourner sur Visual Studio pour le coller
Cloner le dépôt
- Aller sur le dépôt de mathaléa
- Choisir d'ouvrir le code dans Visual Studio Code en passant par le protocole HTTPS comme sur cette capture d'écran
- Choisir dans quel dossier local sera copié le code source de MathALÉA
- Une fois la copie terminée, choisir d'ouvrir le projet
- Choisir de faire confiance aux auteurs pour autoriser l'exécution des extensions
- Accepter d'installer les extensions recommandées dans la pop-up en bas à droite
- Accepter de redémarrer Visual Studio
Quelques derniers réglages
- Ouvrir le terminal de VSC (CTRL+J pour Windows et Linux ou CTRL+` pour Mac).
- Sur Windows, si la première ligne que vous voyez apparaître indique
Windows Powershell
, nous vous conseillons de le remplacer par cmd (si vous voyezMicrosoft Windows [version ...]
vous utilisez déjà cmd et pouvez passer à la suite ! (image). Pour cela :- Comme sur cette image, cliquer sur la petite flèche qui pointe vers le bas à droite du terminal puis sur "Select Default Profile".
- Comme sur cette image, cliquer sur Command Prompt dans le menu qui s'affiche puis fermer le terminal actuel grâce à la petite poubelle en bas à droite.
- Comme sur cette image, vous pouvez réouvrir un nouveau terminal avec (CTRL+J) et vérifier que ce n'est plus powershell mais cmd (s'il y a un souci fermez et relancez VSC).
- Remarque : Si vous voulez conserver powershell, à chaque fois que vous voudrez lancer un script qui commence par
npm
oupnpm
, il faudra faire :-
Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
pour enlever la sécurité. -
pnpm votreCommande
pour exécuter votre commande. -
Set-ExecutionPolicy -ExecutionPolicy Restricted -Scope CurrentUser
pour remettre la sécurité.
-
- Sur Windows, si la première ligne que vous voyez apparaître indique
- (La version 9 étant incompatible avec instrumenpoche) Installer la version 8 de pnpm (uniquement en cas de première installation sur cet ordinateur : si vous tentez de l'installer à nouveau, il vous affichera un message d'erreur vous prévenant qu'il est déjà installé).
- Sur Windows il faut être administrateur et saisir
npm install -g pnpm@8
dans le terminal. - Sur Mac et Linux il faut le préfixer de
sudo
, ce qui donnesudo npm install -g pnpm@8
.
- Sur Windows il faut être administrateur et saisir
- De la même façon, saisir
pnpm install
pour installer les dépendances nécessaires. Il faudra le refaire si vous déplacez le dossier qui contient MathALÉA ou lorsqu'on intégrera de nouveaux outils externes, ce qui n'arrivera pas tous les jours (on préviendra sur Mattermost). - Enfin, vous pouvez lancer
pnpm start
pour lancer votre version locale de MathALÉA - Si http://localhost:5173/alea/ affiche bien MathALÉA, félicitations, vous êtes fin prêt·e à participer à ce projet et vous pouvez même cliquer sur Programmer un exercice si vous voulez apprendre à créer votre premier exercice sans plus attendre.
- Sinon, c'est que cette documentation est encore à améliorer et vous êtes invité·e à faire part de vos soucis sur Mattermost pour qu'on vous aide et qu'on améliore cette documentation
😉