Mise en place d’un module frontend
Prérequis
Pour travailler sur le frontend O3, vous devez disposer des outils et technologies suivants:
- Git - Nous utilisons git pour le contrôle de version.
- Node.js - Nous utilisons Node pour compiler et regrouper le code du frontend. Nous n’utilisons pas Node pour faire tourner le backend ou le serveur. Utilisez la version de Node attendue par le dépôt, généralement documentée dans
.nvmrc,.node-version, la configuration CI ou le README. Si le dépôt ne précise rien, utilisez la version activeLTSet gérez les versions avec nvm ou un outil similaire. - Yarn et Corepack - La plupart des dépôts frontend actuels utilisent Yarn
v4, mais certains dépôts plus anciens utilisent encore Yarnv3ou Yarnv1. Vérifiez le champpackageManagerdans lepackage.jsondu dépôt et utilisez la version correspondante. Lancezcorepack enableune fois sur votre machine pour que la version de Yarn déclarée par le dépôt soit activée automatiquement. - Accès à un backend OpenMRS - Vous aurez besoin d’un backend OpenMRS (dev3 ou local) pour que
yarn startfonctionne.
Organisation du code
Le code dans O3 est organisé en plusieurs monorepos spécifiques au domaine:
- openmrs-esm-core - contient les paquets de base pour le frontend 3.x. Les paquets traitent des questions transversales telles que la gestion des erreurs, les extensions, les utilitaires React, le guide de style, le cadre de base, et plus encore.
- openmrs-esm-patient-chart - contient le tableau de bord du patient qui rend plusieurs widgets incluant les allergies, les conditions, les médicaments, les signes vitaux et les données biométriques.
- openmrs-esm-patient-management - gère les préoccupations liées à la gestion des patients. Il comprend les modules frontaux pour la page d’accueil, la recherche de patients, l’enregistrement des patients, les listes de patients, les rendez-vous, les files d’attente de services et la gestion des lits.
Installation
La plupart du temps, vous travaillerez au sein d’un monorepo. En général, pour installer un de ces monorepos localement, vous devez:
- Cloner le repo qui vous intéresse.
cddans le répertoire racine du repo sur votre copie locale.- Lancez
corepack enablesi Corepack n’est pas encore activé sur votre machine. - Lancez
yarnpour installer les dépendances avec la version déclarée par le dépôt.
Configuration de l’éditeur
Nous utilisons généralement Visual Studio Code lorsque nous développons sur O3. Nous recommandons de configurer les extensions suivantes pour améliorer votre flux de développement:
- Prettier - formatage automatique du code. Tous nos monorepos contiennent une configuration Prettier. L’installation de cette extension permet à Prettier de formater automatiquement votre code à chaque fois que vous effectuez un commit.
- ESLint - outil d’analyse statique du code. ESLint trouve et corrige les problèmes dans votre code et vous aidera à signaler les problèmes de lint au fur et à mesure que vous écrivez votre code.
Prochaines étapes
Vous êtes prêt à construire avec O3. Lisez le guide de développement des modules frontend pour exécuter les modules en local, le guide de contribution pour comprendre le flux de contribution, et les conventions de codage pour aligner votre code sur les attentes du projet.