Sign App

Repositório principal do app Sign desenvolvido pelo IEEE Computational Intelligence Society

Sumário

• Pré-requisitos
• Como Rodar o Projeto
• O que o Script de Automação Faz?
• Solução de Problemas (Troubleshooting)

Pré-requisitos

Antes de começar, certifique-se de que você tem as seguintes ferramentas instaladas e configuradas em sua máquina:

• Git
• Node.js e NPM
• Docker e Docker Compose
• Android SDK Command-Line Tools
• Pelo menos um Emulador (AVD) Você precisa ter um Android Virtual Device criado.

IMPORTANTE: Após instalar o Android SDK, é necessário configurar a variável de ambiente ANDROID_HOME apontando para o diretório do SDK.

• Tutorial de instalação e configuração do Android Studio e AVD Manager

Como Rodar o Projeto

Com o ambiente devidamente configurado,

Passo 1: Clone o Repositório

git clone https://github.com/UnB-CIS/Sign-App.git
cd Sign-App

Passo 2: Execute o Script de Automação

Escolha o comando correspondente ao seu sistema operacional. O comando cobrirá desde a instalação de dependências dentro do Docker até a inicialização do app.

🐧 Para Linux ou macOS no Emulador:

npm install
ANDROID_HOME="/home/$(whoami)/Android/Sdk" npm run dev:start:unix

🐧 Para Linux ou macOS no Dispositivo USB:

npm install
ANDROID_HOME="/home/$(whoami)/Android/Sdk" npm run dev:start:unixdevice

💻 Para Windows (usando CMD ou PowerShell) no Emulador:

npm install
npm run dev:start:win

E pronto, suas alterações no código serão refletidas automaticamente no emulador (Hot Reload).

Dentro dos entrypoints

O comando npm run dev:start:* executa uma série de passos para criar um ambiente de desenvolvimento completo e funcional:

• 1 Verifica se a variável de ambiente ANDROID_HOME está configurada.

• 2 Encontra um emulador Android (AVD) disponível em sua máquina.

• 3 Inicia o emulador automaticamente em segundo plano.

• 4 Aguarda o sistema operacional do emulador carregar por completo.

• 5 Inicia o container Docker (via docker-compose), que irá:

• Construir a imagem, executando npm install dentro do container.

• Iniciar o servidor Metro Bundler. 🔗 Configura o adb reverse, permitindo que o app no emulador se comunique com o Metro dentro do container. 📲 Instala e inicia o aplicativo React Native no emulador.

Solução de Problemas (Troubleshooting)

1. Erro: A variável de ambiente ANDROID_HOME não está definida.

   • Solução: Você precisa criar a variável de ambiente ANDROID_HOME e fazê-la apontar para a pasta onde seu Android SDK foi instalado.

2. Erro: Nenhum emulador (AVD) encontrado.

   • Solução: Você precisa criar um dispositivo virtual através do AVD Manager no Android Studio ou via linha de comando com avdmanager.

3. O Docker parece não funcionar ou o comando docker-compose falha.

   • Solução: Certifique-se de que o Docker Desktop está em execução na sua máquina.

4. O comando adb não foi encontrado.

   • Solução: O adb fica na pasta platform-tools dentro do seu Android SDK. Adicione %ANDROID_HOME%\platform-tools (Windows) ou $ANDROID_HOME/platform-tools (Linux/macOS) à sua variável de ambiente PATH.

5. Erro durante o docker-compose up (falha no npm install dentro do container).

   • Solução: Isso pode ser um problema de rede ou um pacote quebrado no package.json. Tente forçar uma reconstrução limpa da imagem com o comando: docker-compose build --no-cache e depois rode o script de start novamente. Verifique o log do Docker para mensagens de erro específicas do npm.