Skip to content

Weather forecast progressive web application (PWA), developed with React, Vite and TypeScript. Tested with Jest and SonarQube.

License

Notifications You must be signed in to change notification settings

misicode/Weather_App

Repository files navigation

Logo Icon

Weather App

Aplicación de pronóstico del clima
Ver Demo | Reportar Bug | Solicitar Feature


📖 Acerca del repositorio

Aplicación web progresiva (PWA) desarrollada con React que consume la API de OpenWeather para obtener el pronóstico del clima de una determinada ubicación según su nombre, código postal o coordenadas de ubicación.

Construido con

Herramienta Descripción Versión
React Biblioteca de JavaScript para construir las interfaces de usuario 18.3.1
Vite Herramienta de Frontend para construir el proyecto 5.4.10
TypeScript Lenguaje de programación fuertemente tipado para escribir código 5.6.2
Jest Framework de testing para las pruebas unitarias 29.7.0
SonarQube Plataforma para evaluar el código fuente 10.5
NPM Administrador de paquetes para instalar las dependencias 10.5.0
Visual Studio Code Editor de código para el proyecto 1.95.1

Vista previa

🚀 Iniciando el proyecto

Para poner en funcionamiento una copia local de este repositorio, siga los siguientes pasos.

Requisitos previos

Obligatorio

NodeJS >= 16.X
NPM >= 8.X

Opcional

Git
Visual Studio Code

Instalación y configuración

  1. Obtenga una clave API gratuita en OpenWeather.

  2. Descargue o clone este repositorio.

    git clone https://github.com/misicode/Weather_App.git
  3. Instale todos los paquetes NPM.

    npm install
  4. Cree el archivo .env como copia del archivo .env.template e ingrese la clave de su API.

    # OPENWEATHER
    VITE_OPENWEATHER_API_KEY=your_openweather_api_key
  5. Ejecute el proyecto en modo desarrollo.

    npm run dev
    

📋 Testeando el proyecto

Pruebas unitarias

Ejecute el siguiente comando para iniciar los tests unitarios y generar el reporte de cobertura.

npm run test:cov

Visualize los resultados del reporte de cobertura en la ruta ./coverage/lcov-report/index.html.

🔍 Evaluando la calidad de código

Requisitos previos

SonarQube >= 9.X

Configuración

  1. Inicie el servicio de SonarQube.

  2. Edite la sección de configuración de Sonar en el archivo sonar-project.properties con sus credenciales de acceso.

    # Sonar configuration
    sonar.host.url=http://localhost:9000/
    sonar.login=admin
    sonar.password=Admin1
  3. Ejecute el escaneo de Sonar.

    npm run sonar
    

Resultados

💼 Licencia

Distribuido bajo la licencia MIT. Consulte LICENSE.txt para obtener más información.

🌸 Contacto

Desarrollado por Alessandra Mincia

Misicode GitHub LinkedIn

📝 Agradecimientos

La idea de este proyecto surgió como iniciativa del workshop "SheCodes React", de SheCodes.

About

Weather forecast progressive web application (PWA), developed with React, Vite and TypeScript. Tested with Jest and SonarQube.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published