An open API service indexing awesome lists of open source software.

https://github.com/f4gn3r/weather-now

Web application for viewing climate information by region developed with Vite
https://github.com/f4gn3r/weather-now

typescript vite web

Last synced: about 2 months ago
JSON representation

Web application for viewing climate information by region developed with Vite

Awesome Lists containing this project

README

          

☂️ Weather Now



  1. Descrição

  2. Funcionalidades

  3. Requisitos

  4. Tecnologias Utilizadas

  5. Instalação e Configuração

  6. UX/UI de Inspiração

  7. Arquitetura do Projeto

  8. Ambiente de produção

  9. Contribuição

  10. Licença

  11. Pontos de Expansão Futuros

  12. Cronograma Estimado

  13. Autor

Descrição

Este projeto implementa uma interface web para busca e visualização de informações climáticas utilizando **Vite**.

Funcionalidades

- **Previsão por localização**: Permite buscar a previsão climática de acordo com a localização do dispositivo.
- **Previsão por busca**: Permite buscar a previsão climática por cidade.
- **Previsão atual**: Exibe a previsão climática atual.
- **Previsão do dia**: Exibe a previsão das próximas horas do dia.
- **Previsão da semana**: Exibe a previsão dos próximos 7 dias.
- **Condições do ar**: Exibe informações sobre as condições do ar.

Requisitos

### Requisitos Funcionais

- Acesso a localização do dispositivo.
- Exibição de informações climáticas.
- Atualização das informações em tempo real.

### Requisitos Não Funcionais

- **Segurança**: -
- **Escalabilidade**: -
- **Manutenibilidade**: -

Tecnologias Utilizadas

- **Vite**: Framework principal.
- **TypeScript**: Linguagem de programação.
- **Tailwindcss**: Para customização dos componentes.
- **OpenWeather**: API de dados climáticos.
- **TanStack Query**: Gerenciamento de estados e controle de dados.
- **Netlify**: Para ambiente de produção.

Instalação e Configuração

### Pré-requisitos

- Node.js
- Pnpm

### Passos para Instalação

1. Clone o repositório:

```bash
git clone https://github.com/F4GN3R/weather-now
```

2. Instale as dependências:

```bash
$ cd weather-now && pnpm install
```

3. Configure as variáveis de ambiente no arquivo `.env`:

```bash
# OPEN WEATHER
OPEN_WEATHER_URL=""
OPEN_WEATHER_API_KEY=""
```

4. Inicie o servidor:

```bash
# development
$ pnpm run dev

# production mode
$ pnpm run preview
```

5. Acesse a aplicação em:

```bash
http://localhost:5173
```

UX/UI de Inspiração

![alt text](ui-ux-inspiration.png)

Arquitetura do Projeto

### Componentes

- **-**: -.
- **-**: -.
- **-**: -.

Ambiente de produção

Para produção, escolhemos a plataforma [Netlify](https://www.netlify.com/) para a aplicação.

```bash
https://-
```

Contribuição

1. Faça um fork do projeto.
2. Crie uma nova branch para a feature (`git checkout -b feature/nova-feature`).
3. Commit suas mudanças (`git commit -am 'Adiciona nova feature'`).
4. Faça o push para a branch (`git push origin feature/nova-feature`).
5. Abra um Pull Request.

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo [LICENSE](LICENSE) para mais detalhes.

Pontos de Expansão Futuros

- **Armazenamento das ultimas localizações**: Salvar as últimas buscas realizadas para consulta.
- **Tema**: Permitir a preferência de tema (system/dark/light).
- **Multi Idiomas**: Visualização em PT-BR, EN e SP.
- **Logs de Acesso**: Registrar acessos e interações com a aplicação.
- **Registro de usuários**: Permitir contatos de usuários para registro de bugs ou sugestões.

Cronograma Estimado

| Fase | Tempo Estimado |
| -------------------------- | -------------- |
| Levantamento de Requisitos | 1 dia |
| Configuração do Projeto | 1 dia |
| Desenvolvimento Frontend | 2 dias |
| Integrações | 2 dias |
| Testes e Correções | 2 dias |
| Documentação | 1 dia |
| Deploy em produção | 1 dia |
| **Total estimado** | **10 dias** |

Autor




F4GN3R



Fagner Morais


Full Stack Developer and Senior System Analist

[![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/F4GN3R)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/fagner-morais-6732a7130/)

Esse `README.md` serve como uma documentação completa do projeto e pode ser utilizado diretamente no GitHub.