README.md

Beach-Forecast-API

Este projeto foi feito sequindo o curso do meste Waldemar Neto
A playlist do curo esta em: https://www.youtube.com/channel/UCqmJGTdcMIRXOZuukHZ8TqA

Esta API consiste em utilizar um serviço de forecast para que possa classificar a qualidade das ondas nas praias cadastradas.
É utilizada a versão gratis da api do Stormglass para fornecer os forecast. Esta versão posui uma limitação de 50 requests por dia.

Tecnologias utilizadas

---

Principais tecnologias utilizadas no código.

💻 Node.js

🧰 Typescript

✅ Jest

📦 MongoDB

🛠 Github Actions

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando a aplicação

# Clone este repositório
$ git clone https://github.com/lucasdrta/Beach-Forecast-API

# Acesse a pasta do projeto no terminal/cmd
$ cd Beach-Forecast-API

# Instale as dependências
$ yarn ou npm install

# Execute os testes
$ yarn test

# Compilando a aplicação
$ yarn build

# Execute a aplicação
$ yarn start

# O servidor inciará na porta:3000 - acesse <http://localhost:3000>

# Necessario ter o serviço do MongoDB em execução.

Instalação com Docker

Caso prefira inicializar um ambiente de desenvolvimento com Docker, o app possui um arquivo docker-compose.yml preparado com as configurações necessárias.

Pré-requisitos

• Docker
• Docker Compose

Inicializando os contêineres

$ docker-compose up -d --build

😯 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Lucas Duarte.