diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..c87c2d1 --- /dev/null +++ b/.env.example @@ -0,0 +1,13 @@ +GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY" +API_URL="https://plutao.geogridmaps.com.br/vale/api/v3/viabilidade/raio" +API_KEY="YOUR_API_KEY" +COOKIE="YOUR_COOKIE" +PORT="3000" + +API_VIABILIDADE_URL="https://api.sothis.com.br/api/viabilidade" + +DATABASE_HOST="DB_HOST" +DATABASE_PORT="3306" +DATABASE_NAME="viabilidade_data" +DATABASE_USER="viabilidade_user" +DATABASE_USER_PASSWORD="YOUR_DB_PASSWORD" diff --git a/.gitignore b/.gitignore index 40b878d..3ec544c 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -node_modules/ \ No newline at end of file +node_modules/ +.env \ No newline at end of file diff --git a/README.md b/README.md index ea3d69f..426c27a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# Aplicação Viabilidade +# Aplicacao Viabilidade -Pequena aplicação Node.js para processar CSVs com endereços/lat-lon e consultar a API de viabilidade. +Aplicacao web em Node.js para consultar viabilidade tecnica a partir de enderecos ou coordenadas (lat/lon). Ela permite: +- Upload de CSV com enderecos ou lat/lon para processamento em lote. +- Consulta manual por coordenadas no navegador. +- Geracao de CSV de saida com os resultados. -Como usar: - -1. Abra um terminal e entre na pasta `aplicação viabilidade`. -2. Crie um virtualenv Node e instale dependências: +**Como usar** +1. No terminal, entre na pasta do projeto. +2. Instale as dependencias: ```powershell npm install @@ -17,8 +19,8 @@ npm install npm start ``` -4. Abra `http://localhost:3000` no navegador. Faça o upload do CSV ou consulte manualmente por latitude/longitude. +4. Acesse `http://localhost:3000` e faca o upload do CSV ou consulte manualmente. -Notas: -- Configure variáveis de ambiente `API_KEY` e `COOKIE` se quiser usar credenciais diferentes. -- O CSV de saída é gravado em `aplicação viabilidade/outputs` com ponto-e-vírgula como separador. +**Notas** +- As variaveis de ambiente ficam em `.env` (veja `.env.example`). +- O CSV de saida e gravado em `outputs` com ponto-e-virgula como separador.