/weather-app-backend

An application that provides real-time information about weather forecast. This is the server version. Front-end is available (soon) at https://github.com/vitorpessoti/weather-app-frontend. Mobile is available at https://github.com/vitorpessoti/weather-app-mobile.

Primary LanguageJavaScript

☁️ Weather App API

☀️ Uma api desenvolvida em Javascript que prove informações climáticas em tempo real.

🚧 Em andamento 🛠️ 🚧

Tabela de conteúdos

💻 Sobre o projeto

Em desenvolvimento

🖥️ Regras de negócio

🖥️ Em desenvolvimento;

⚙️ Funcionalidades

  • Em desenvolvimento:

🚀 Como executar o projeto

Este projeto vai ser dividido em:

  1. Backend
  2. App
  3. Frontend (Futuramente)

💡 O App precisa que o Backend esteja sendo executado para funcionar.

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 o Backend (servidor)

# Versão v16.15.0 do Node
# Verifique que você já possui os pré-requisitos instalados
# Crie um banco de dados, as tabelas vão ser geradas automáticamente quando terminar todos esses passos
# Clone este repositório
$ git clone git@github.com:vitorpessoti/weather-app-backend.git
# Acesse a pasta do projeto no terminal/cmd
$ cd weather-app-backend
# Instale as dependências
$ npm install ou yarn install
# Crie um arquivo .env na raiz do projeto
$ touch .env ou crie um arquivo pela IDE
# Vá para o arquivo .env.example e copie os dados do .env.example e cole no .env
# Altere os dados do .env e mude para os dados do seu ambiente
# APP_PORT= insira a porta que deseja rodar o servidor, geralmente usa-se a "3333".
# API_KEY= aqui geralmente usa-se "localhost".
# GEODB_HOST= insira o nome do banco de dados que você criou.
# GEODB_KEY= insira o usuário do banco de dados, geralmente é "root".
# Execute a aplicação em modo de desenvolvimento
$ npm run dev ou yarn dev
# O servidor iniciará na porta:3333 por padrão - acesse http://localhost:3333
# Observações: 
# Essa porta é referente ao APP_PORT presente no .env, se você alterar, terá que mudar a porta "3333" para a que você definiu.

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Server (NodeJS)

Utilitários

🦸 Autor