mateusbmp/openstreetmaps

Classe de interação com API do OpenStreetMaps

Classe de interacao com API do OpenStreetMaps

---

Apresentacao

Esse projeto simplifica o uso da API do OpenStreetMaps, transcrevendo-a a funcoes simples com poucos parametros de entrada. Toda sua documentacao foi feita usando Markdown.

Para visualizacao mais facil da documentacao, pode-se usar qualquer leitor de Markdown, como o Dillinger.

Executando o sistema

Usando o XAMPP e posicionando a pasta do projeto na pasta htdocs, usando como nome de pasta \osm\, pode-se acessar a pagina inicial pelo endereco:

• http://localhost/osm/src/src/views/home.php

Como o projeto é baseado em uma classe e em testes de suas funcoes, sua pagina inicial serve apenas de interacao para todo o projeto. Ou seja, a pagina inicial independe ao bom funcionamento da aplicacao. Use-a apenas para testes.

Para uso das classes a partir do composer, e necessario a sua execucao, ou seja:

• composer install
• composer dump-autoload

Se necessario, use posteriormente composer update e composer dump-autoload -o.

Exemplos de uso

Para exemplos simplificados de uso, veja os feature tests presentes no arquivo featureTest.php no diretorio src/tests/. Tambem ha exemplos simples nas views presentes do diretorio src/src/views/.

openstreetmaps's Issues

Reestruturação de pastas

Como a estrutura geral do sistema se encontra mal formatada, dificultando a navegação e bom entendimento da biblioteca, rearrumar as pastas para melhorar a legibilidade é recomendável, lembrando de reconfigurar o composer para seu correto funcionamento.

Implementar actions para automatizar testes unitários

Com a nova funcionalidade disponibilizada, a GitHub Actions, sugere-se a implementação da mesma para automatização dos testes presentes aqui.

Documentação do código

A biblioteca está documentada em um arquivo markdown separado, mas a mesma se encontra limitada e sem um padrão estabelecido. Desta forma recomenda-se o uso da PSR-5: PHPDoc para melhorar a documentação do projeto.