ciclomputador

Projeto de código aberto que trata e disponibiliza os dados coletados pela equipe avaliadora de campo através da ferramenta de auditoria cicloviária do IDECICLO.

Execução do Script

⚠️ versão node 14.21.3

clone o repositório

git clone https://github.com/Ameciclo/ciclomputador.git

entre na pasta

cd ciclomputador

instale as dependências

npm install

rode o script

npm start

💡 Algo assim deve aparecer: details>

    Foram encontrados 332 arquivos
    Processando dados GPX
    GPX 2024-04-09_10-15-35 processado...
    GPX 2024-04-13_13-47-56 processado...
    GPX 2024-04-13_16-02-50 processado...
    GPX 2024-04-13_18-13-36 processado...
    GPX 2024-04-13_18-34-41 processado...
    GPX 2024-04-14_06-55-44 processado...
    GPX 2024-04-14_07-57-33 processado...
    GPX 2024-04-14_08-26-29 processado...
    GPX 2024-04-14_14-36-37 processado...
    GPX 2024-04-16_07-48-06 processado...
    GPX 2024-04-16_08-51-15 processado...
    GPX 2024-04-16_09-55-43 processado...
    GPX 2024-04-16_10-45-57 processado...
    GPX 2024-04-16_14-50-14 processado...
    GPX 2024-04-16_15-25-33 processado...
    GPX 2024-04-16_15-53-42 processado...

Passo a Passo de Uso

1 - Substitua os arquivos GPX de avaliação na pasta src/gpx-files (ou rode com os arquivos gpx já presentes)

2 - rode o comando de execução do script npm start

3 - 💡 uma pasta em src chamada result vai conter um arquivo data.json com os dados de cada arquivo gpx processados.

Entendendo mais sobre o JSON gerado:

a estrutura basica do JSON resultado é a seguinte:

• um array de objetos [{},{},{}...]
• cada objeto desse array representa um acumulado de dados de cada GPX

ex.:

[
  {
    result: {},
    metadata: {},
    ... acumulado de dados brutos
  },
  ...
]

• "result" - dados finais para consumo
• "metadata" - dados básicos informativos sobre o conteúdo analizado
• "acumulado de dados brutos" - são todas as categorias e botões contabilizados no gpx analizado, necessário para construir o elemento "resume"

Contribuindo com o Projeto:

Na pasta clonada do projeto:

• Crie sua branch no padrão sugerido

dev-{seu_nick}

ex.: git checkout -b dev-joao

• Commite suas alterações no padrão sugerido

evento_da_modificacao: mensagem_da_modificacao

ex.: git commit -m "fix: erro ao processar gpx sem descricao"

• Suba suas Modificações

ao subir a primeira vez git push -u origin sua_branch

ex.: git push -u origin dev-joao

git push (caso nao seja primeira vez)

• Crie seu PR Volte neste repositório e aceite a criação do seu PR, renomeie-o descrevendo brevemente sobre a melhoria proposta.

• Solicite revisão dentro do seu PR

• Aguarde aprovação do PR para merge