https://github.com/andrelmlins/previsao-ondas

🌊 Scraping de previsão de ondas no Brasil
https://github.com/andrelmlins/previsao-ondas

api brasil hacktoberfest ondas previsao scraping

Last synced: about 1 month ago
JSON representation

🌊 Scraping de previsão de ondas no Brasil

• Host: GitHub
• URL: https://github.com/andrelmlins/previsao-ondas
• Owner: andrelmlins
• License: mit
• Created: 2019-05-27T09:31:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T21:23:29.000Z (3 months ago)
• Last Synced: 2024-09-18T02:15:48.027Z (3 months ago)
• Topics: api, brasil, hacktoberfest, ondas, previsao, scraping
• Language: TypeScript
• Homepage: https://previsao-ondas.herokuapp.com/
• Size: 324 KB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌊 API de Previsão de Ondas 🌊

API de previsão de ondas no Brasil feita através de um WebScraping na área de ondas do INPE, acesse através do [Link](https://previsao-ondas.herokuapp.com/).

[![Build Status](https://travis-ci.com/andrelmlins/previsao-ondas.svg?branch=master)](https://travis-ci.com/andrelmlins/previsao-ondas)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/andrelmlins/previsao-ondas/blob/master/LICENSE)

[![Known Vulnerabilities](https://snyk.io/test/github/andrelmlins/previsao-ondas/badge.svg)](https://snyk.io/test/github/andrelmlins/previsao-ondas)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/andrelmlins/previsao-ondas.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/andrelmlins/previsao-ondas/context:javascript)

## Como rodar

```

# instalar as dependências

yarn install

# iniciar a API

yarn start

```

## Documentação

A documentação feita através do [Swagger](https://swagger.io/) se encontra em [Link](https://previsao-ondas.herokuapp.com/api-docs).

## Como usar

Abaixo a lista básica de rotas

- Estados Litorâneos -> http://previsao-ondas.herokuapp.com/litoral/estados

- Detalhes do Estado: -> http://previsao-ondas.herokuapp.com/litoral/estado/PE

- Previsão de Ondas por Cidade: -> http://previsao-ondas.herokuapp.com/ondas/cidade/1058

## Docker

[![dockeri.co](https://dockeri.co/image/andrelmlins1/previsao-ondas)](https://hub.docker.com/r/andrelmlins1/previsao-ondas)

A imagem docker oficial disponívelse encontra em [Dockerhub](https://hub.docker.com/r/andrelmlins1/freesoccer):

```

$ docker pull andrelmlins1/previsao-ondas

$ docker run -d -p 80:8080 --name andrelmlins1/previsao-ondas

```

## Tecnologias

- NodeJS

- Express

- Cheerio

- Axios