Guia do Desenvolvedor

Essas instruções vão fazer com que você faça uma cópia do AMRnet esteja a funcionar na sua máquina para fins de desenvolvimento e teste. AMRnet é um aplicativo web completo construído com Node.js, React, e MongoDB.

Pré-requisitos

Antes de instalar o AMRnet, certifique-se de que você tem o seguinte software instalado:

  • Node.js: v18.20.4 ou superior (especificado em .nvmrc)

  • npm: Versão mais recente (vem com Node.js)

  • Python: v3.8+ (para componentes de processamento de dados)

  • Git: Versão mais recente para controle de versão

  • MongoDB: v6.0+ (instalação local ou banco de dados de nuvem do MongoDB Atlas)

Você pode verificar suas versões instaladas com:

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

Início rápido

Siga estes passos para que a AMRnet funcione localmente:

1. Clonar o repositório

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

2. Instale as dependências

# Install backend dependencies
npm install

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

3. Configuração de ambiente

# 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 Desenvolvimento

# 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. Acesse o aplicativo

Abra seu navegador e navegue para http://localhost:3000 para ver o painel AMRnet.

Configurações de Desenvolvimento

Para uma configuração detalhada de desenvolvimento, incluindo ferramentas de qualidade de código e melhores práticas:

Gerenciamento de versões do Node.js

O AMRnet usa o Node.js v18.20.4. Se você usar nvm (Gerenciador de Versão do Não):

# 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

Dependências do Python

Para componentes de processamento de dados e construção de documentação:

# Install Python dependencies
pip install -r requirements.txt

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

Variáveis de Ambiente

Configure o seu arquivo .env com as seguintes variáveis:

# 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

Compilação de Produção

Para construir o AMRnet para o deploy de produção:

# Build the client application
npm run build

# Start the production server
npm start

A aplicação construída será servida do diretório client/build.

Instalação do Docker

O AMRnet também pode ser executado usando o Docker:

# Build the Docker image
docker build -t amrnet .

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

Certifique-se de substituir your_mongodb_uri pela string de conexão atual do MongoDB.

Solução de problemas

Problemas de instalação comuns:

  1. Node version inmatch: Use nvm use para alternar para a versão correta

  2. Conflito de pacote: Exclua node_modules e execute npm install novamente

  3. Conflitos da porta: Certifique-se de que as portas 3000 e 8080 estejam disponíveis

  4. Conexão do MongoDB: Verifique se seu serviço do MongoDB está sendo executado ou se as credenciais do Atlas estão corretas

Obter Ajuda: