Projeto de Conclusão

Técnica de Programação

Aplicação desktop de uma pesquisa de endereço por cep e informações de um local.

Aplicação em Java GitHub

• Requisitos
• Download do Projeto
• Configurando o Projeto
• Iniciando o projeto
• Requisições_e_Resposta
• Features
• Scripts
• Exceções
• Tecnologias

👨‍🚀 Membros

Leandro Bergamo 👨‍🚀

Guilherme Rocha 👨‍🚀

📎 Download do projeto

# Clone este repositório

# Sem ssh
$ git clone https://github.com/lbbergamo/ProjetoConclusaoDisciplina-backend

# Com ssh 
$ git clone [email protected]:lbbergamo/ProjetoConclusaoDisciplina-backend.git

⚙️ Requisito para executar

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

Git e Node.js.

Além disto é bom ter um editor para trabalhar com o código como VSCode

# NodeJs 
> Superior ao 12

💾 Configurando o projeto

1. Crie um arquivo na raiz do projeto com o nome ".env"

2. Digite o valor das variáveis de acordo com o seu banco de dados MySQL e a Porta

PORT=
GOOGLE_KEY=
GOOGLE_URL_GEOCODE=https://maps.googleapis.com/maps/api/geocode/
INFO_CEP_URL=http://cep.bldstools.com/
WEATHER_URL=https://api.openweathermap.org/data/2.5/weather
WEATHER_TOKEN=
AUTHORIZATION=

3. Para realizar o cadastrar o google key utilize o site https://developers.google.com/

4. Para conseguir o weather token acesse o site https://home.openweathermap.org/users/sign_in

📃 Requisições e Respostas

CEP

Requisição

{
    "cep":"00000-000"
}

Retorno com sucesso

{
    "CEP": "",
    "Endereco": {
        "logradouro": "",
        "bairro": "",
        "localidade": "",
        "uf": "",
        "cep": ""
    },
    "tempo": {
        "status": "céu limpo",
        "temperatura": 24
    },
    "googleMaps": {
        "latitude": -23,
        "longitude": -46
    }
}

💻 Iniciando o projeto

# Navegue até ele e instale todas as dependências
$ npm install

# Inicie o modo de desenvolvimento
$ npm run dev

📝 Scripts

# Inicia a aplicação em modo de desenvolvimento
$ npm run dev

# Compila o Typescript para Javascript, deixando a aplicação pronta para produção
$ npm run build

# Inicie a aplicação em modo de produção
$ npm start

# Roda os arquivos de testes
$ npm test

📖 Features

• Estrutura de pastas
• Ambiente de Desenvolvimento
  • Configuração de teste
  • Docker
• Primeiro deploy
• CEP
  • Realizar a consulta do CEP
    • Utilizar a api http://cep.bldstools.com/?cep=CEP_NUMBER
  • Realizar a consulta da logitude
    • Utilizar a api https://maps.googleapis.com/maps/api/geocode/json?address=CEP_NUMBER&key=MINHA_KEY
  • Retornar os dados conforme json abaixo

    {
      "CEP": "11045-907",
      "Endereco": {
          "logradouro": "Rua Oswaldo Cruz, 266",
          "bairro": "Boqueirão",
          "localidade": "Santos",
          "uf": "SP",
          "cep": "11045907"
      },
      "tempo": {
          "status": "céu limpo",
          "temperatura": 24.89
      },
      "googleMaps": {
          "latitude": -23.9633391,
          "longitude": -46.3217163
      }
    }

• Conclusão do README

⚠️ Exceções

1. ✅ Retorna erro 200 a consulta for feita com sucesso
2. ✅ Retorna erro 401 se o authorization não for valido
3. ✅ Retorna erro 404 não foi encontrado o cep
4. ✅ Retorna erro 500 ocorreu um erro

🔮 Tecnologias

• typescript
• jest
• eslint
• babel
• Node.js
• dotenv