Uma aplicação web para buscar endereços a partir de um CEP feita com Ruby on Rails, SQLite, HTML/CSS/JS

• Instalação
• Testes
• Funcionalidades
  • Buscar endereço
  • CEPs mais buscados
  • CEPs mais buscados por estado/cidade
  • Quantidade de CEPs buscados por estado
• Banco de Dados
  • Popular o banco de dados
• Motivação

• Git
• Ruby
• Rails
• SQLite

git clone https://github.com/hreis1/buscaCep.git
cd buscaCep

bundle install

rails bin/setup

rails s

acesse a aplicação em http://localhost:3000

Execute o comando para rodar os testes:

rspec

Os testes são feitos com RSpec e cont´em testes unitários para os models e testes de sistema para a tela com o javascript.

Na página inicial, digite um CEP no campo de busca e após digitar o oitavo dígito, o endereço correspondente ao CEP será exibido. Caso o CEP não exista, uma mensagem de erro será exibida. Não é possível digitar letras ou caracteres especiais no campo de busca e o campo aceita apenas 8 dígitos. Assim que a página é carregada, o campo de busca é focado.

Os CEPs mais buscados são exibidos numa caixa embaixo do campo de busca. Cada CEP tem a quantidade de vezes pesquisado. Caso não haja CEPs pesquisados, a caixa não é exibida.

Os CEPs mais buscados por estado/cidade são exibidos numa caixa embaixo do campo de busca. Cada CEP tem a quantidade de vezes pesquisado. Caso não haja CEPs pesquisados, a caixa não é exibida.

A quantidade de CEPs buscados por estado é exibida numa caixa embaixo dos campos anteriores. Cada estado tem a quantidade de CEPs pesquisados. Caso não haja CEPs pesquisados, a caixa não é exibida.

O banco de dados utilizado é o SQLite. Ele é criado automaticamente quando o servidor é iniciado pela primeira vez, inicializado com as configurações do arquivo ./db/schema.rb, criando as tabelas necessárias.

Execute o comando para popular o banco de dados com alguns CEPs:

rails db:seed

A aplicação foi feita para ser simples e eficiente. A busca de endereços a partir de um CEP é feita de forma rápida e sem a necessidade de recarregar a página ou usar o mouse para selecionar o input. Além disso, a aplicação exibe informações úteis como os CEPs mais buscados e a quantidade de CEPs buscados por estado. Os testes foram feitos para garantir o funcionamento correto da aplicação inclusive com o javascript. A consulta de endereços é feita buscando o CEP primeiramente na base de dados local, evitando consultas desnecessárias à API externa, e caso o CEP não seja encontrado, a aplicação faz uma consulta à API externa através do modelo 'SearchCep' que encapsula a lógica de busca de CEPs.