Guía de Desarrollador

Estas instrucciones le proporcionarán una copia de AMRnet en funcionamiento en su máquina para fines de desarrollo y prueba. AMRnet es una aplicación web completamente compilada con Node.js, React, y MongoDB.

Prerrequisitos

Antes de instalar AMRnet, asegúrese de tener el siguiente software instalado:

  • Node.js: v18.20.4 o superior (especificado en .nvmrc)

  • npm: Última versión (viene con Node.js)

  • Python: v3.8+ (para componentes de procesamiento de datos)

  • Git: última versión para control de versiones

  • MongoDB: v6.0+ (instalación local o base de datos de MongoDB Atlas)

Puede comprobar las versiones instaladas con:

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

Inicio rápido

Siga estos pasos para que AMRnet se ejecute localmente:

1. Clonar el Repositorio

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

2. Instalar dependencias

# Install backend dependencies
npm install

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

3. Configuración de entorno

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

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

4. Iniciar Servidores de Desarrollo

# 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. Accede a la aplicación

Abra su navegador y vaya a http://localhost:3000 para ver el panel de control de AMRnet.

Configuración de desarrollo

Para una configuración de desarrollo detallada, incluyendo herramientas de calidad de código y mejores prácticas:

Gestión de versiones Node.js

AMRnet utiliza Node.js v18.20.4. Si utiliza 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

Dependencias de Python

Para componentes de procesamiento de datos y construcción de documentación:

# Install Python dependencies
pip install -r requirements.txt

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

Variables de entorno

Configura tu archivo .env con las siguientes variables:

# Application settings
NODE_ENV=development
PORT=8080

# Database configuration
MONGODB_URI=mongodb://localhost:27017/amrnet
# Or for MongoDB Atlas:
# MONGODB_URI=mongodb+srv://username:password@cluster.mongodb.net/amrnet

# Optional: Fixie proxy for Heroku deployment
# FIXIE_URL=socks5://username:password@proxy-host:port

Construcción de Producción

Para construir AMRnet para despliegue de producción:

# Build the client application
npm run build

# Start the production server
npm start

La aplicación construida se servirá desde el directorio client/build.

Instalación de Docker

AMRnet también puede ejecutarse usando Docker:

# Build the Docker image
docker build -t amrnet .

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

Asegúrese de reemplazar your_mongodb_uri con su cadena de conexión MongoDB.

Solución de problemas

Problemas comunes de instalación:

  1. No coincide la versión del nodo: Usa nvm use para cambiar a la versión correcta

  2. Conflictos de paquete: Elimina node_modules y ejecuta npm install de nuevo

  3. Conflictos portuarios: Asegúrate de que los puertos 3000 y 8080 estén disponibles

  4. Conexión MongoDB: Verifique que su servicio MongoDB se está ejecutando o que las credenciales de Atlas son correctas

Obteniendo ayuda: