Guide du développeur

Ces instructions vous donneront une copie de AMRnet fonctionnant sur votre machine à des fins de développement et de test. AMRnet est une application web full-stack construite avec Node.js, React et MongoDB.

Pré-requis

Avant d’installer AMRnet, assurez-vous d’avoir le logiciel suivant installé :

  • Node.js : v18.20.4 ou supérieur (spécifié dans .nvmrc)

  • npm: Dernière version (fournie avec Node.js)

  • Python : v3.8+ (pour les composants de traitement de données)

  • Git : Dernière version pour le contrôle de version

  • MongoDB: v6.0+ (local installation; production runs MongoDB on the application EC2 host and exposes it via SSH tunnel)

Vous pouvez vérifier vos versions installées avec :

node --version
npm --version
python --version
git --version

Démarrage rapide

Suivez ces étapes pour que AMRnet fonctionne localement :

1. Cloner le dépôt

git clone https://github.com/amrnet/amrnet.git
cd amrnet

2. Installez les dépendances

# Install backend dependencies
npm install

# Install frontend dependencies
cd client && npm install && cd ..

3. Configuration de l’environnement

# Create environment file from template
cp .env.example .env

# Edit .env file with your configuration
# Add your MongoDB connection string and other settings

4. Lancer les serveurs de développement

# Start both backend and frontend in development mode
npm run start:dev

# Or start them individually:
npm run start:backend  # Backend only (port 8080)
npm run client         # Frontend only (port 3000)

5. Accéder à l’application

Ouvrez votre navigateur et accédez à http://localhost:3000 pour voir le tableau de bord AMRnet.

Configuration du développement

Pour une configuration de développement détaillée, incluant des outils de qualité de code et les meilleures pratiques :

Gestion des versions de Node.js

AMRnet utilise Node.js v18.20.4. Si vous utilisez nvm (Node Version Manager):

# Use the project's specified Node.js version
nvm use

# Or install the specific version if not available
nvm install v18.20.4
nvm use v18.20.4

Dépendances Python

Pour le traitement des données des composants et la construction de la documentation:

# Install Python dependencies
pip install -r requirements.txt

# Install documentation dependencies
pip install -r docs/requirements.txt

Variables d’environnement

Configurez votre fichier .env avec les variables suivantes :

# Application settings
NODE_ENV=development
PORT=8080

# Database configuration
MONGODB_URI=mongodb://localhost:27017/amrnet
# Production hosts MongoDB on the application EC2 instance (bound to
# 127.0.0.1). Use ssh -L 27018:127.0.0.1:27017 to reach it from Compass.

Construction de Production

Pour construire AMRnet pour le déploiement en production :

# Build the client application
npm run build

# Start the production server
npm start

L’application compilée sera servie depuis le répertoire client/build.

Installation de Docker

AMRnet peut également être exécuté en utilisant Docker:

# Build the Docker image
docker build -t amrnet .

# Run the container
docker run -p 8080:8080 -e MONGODB_URI=your_mongodb_uri amrnet

Assurez-vous de remplacer your_mongodb_uri par votre vraie chaîne de connexion MongoDB.

Dépannage

Problèmes d’installation courants:

  1. Différence de version de Node: Utilisez nvm use pour basculer vers la version correcte

  2. Conflit de paquets : Supprimez node_modules et lancez à nouveau npm install

  3. Conflit de ports : Assurez-vous que les ports 3000 et 8080 sont disponibles

  4. MongoDB connection: Verify the MongoDB service is running locally, or that the SSH tunnel to the EC2 host is open

Obtenir de l’aide: