Blazor.QuickWeather

Blazor.QuickWeather is a Blazor-based weather application that provides current weather and forecast information using multiple weather APIs. The solution is built with .NET 8 and leverages Serilog for logging.

Features

Display current weather information
Display 7-day weather forecast
Support for multiple weather APIs (OpenWeatherMap, WeatherApi)
Blazor Server support
Configurable via appsettings.json and user secrets
Easy integration and widget registration
Includes standalone libraries for OpenWeatherMap and WeatherApi with API object model and HTTP client.

Projects

Blazor.QuickWeather: Razor Class Library containing models, services, utilities for weather data retrieval and the weather components.
Blazor.QuickWeather.BlazorServer: Blazor Server application that hosts the demo page showcasing the components and usage of the widgets.
Blazor.QuickWeather.OpenWeatherMap: Library for interacting with the OpenWeatherMap API.
Blazor.QuickWeather.WeatherApi: Library for interacting with the WeatherApi API.

Getting Started

Prerequisites

.NET 8 SDK
Visual Studio 2022 or later

Configuration

Set up user secrets for API keys:

dotnet user-secrets init --project Blazor.QuickWeather.BlazorServer
                dotnet user-secrets set "WeatherApiResources:OpenWeatherMap:CurrentApiKey" "your_openweathermap_api_key" --project Blazor.QuickWeather.BlazorServer
                dotnet user-secrets set "WeatherApiResources:OpenWeatherMap:OneCallApiKey" "your_openweathermap_api_key" --project Blazor.QuickWeather.BlazorServer
                dotnet user-secrets set "WeatherApiResources:WeatherApi:ApiKey" "your_weatherapi_api_key" --project Blazor.QuickWeather.BlazorServer

Update appsettings.json if needed:

{
  "WeatherApiResources": {
    "OpenWeatherMap": {
      "CurrentApiKey": "",
      "OneCallApiKey": ""
    },
    "WeatherApi": {
      "ApiKey": ""
    }
  }
}

Running the Application

Open the solution in Visual Studio.
Set Blazor.QuickWeather.BlazorServer as the startup project.
Press F5 to build and run the application.

Registering Weather Sources

Blazor.QuickWeather provides extension methods to simplify adding weather services to your application. You can register the weather services and APIs in the Program.cs file:

using Blazor.QuickWeather.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Configure QuickWeather
builder.Services.AddQuickWeather(options =>
{
    // Additional configuration if needed
});

// Register OpenWeatherMap API
builder.Services.AddOpenWeatherMap(options =>
{
    options.CurrentWeatherApiKey = builder.Configuration["WeatherApiResources:OpenWeatherMap:CurrentApiKey"];
    options.OneCallApiKey = builder.Configuration["WeatherApiResources:OpenWeatherMap:OneCallApiKey"];
});

// Register WeatherApi API
builder.Services.AddWeatherApi(options =>
{
    options.ApiKey = builder.Configuration["WeatherApiResources:WeatherApi:ApiKey"];
});

var app = builder.Build();

Usage

After registering the services and weather sources, you can use the <QuickWeatherBasic> or <QuickWeatherSmall> component in your Blazor pages to display weather data. Here's how to use it:

Basic Example

<QuickWeatherBasic Source="WeatherDataSource.WeatherApi"
                   IncludeForecast="true"
                   UseSourceIcons="true"
                   UpdateIntervalSeconds="300" />

Parameters

Parameter	Type	Description
`Source`	`WeatherDataSource`	Specifies the weather source to use. Options are `WeatherApi` or `OpenWeatherMap`.
`IncludeForecast`	`bool`	Determines whether to include a 7-day weather forecast. Defaults to `false`.
`UseSourceIcons`	`bool`	Indicates whether to use the weather icons provided by the selected weather API. Defaults to `false`.
`UpdateIntervalSeconds`	`int`	Specifies the interval (in seconds) for refreshing weather data. Set to `0` to disable auto-refresh.

Customization Example

<QuickWeatherBasic Source="WeatherDataSource.OpenWeatherMap"
                   IncludeForecast="false"
                   UseSourceIcons="true"
                   UpdateIntervalSeconds="600" />

Logging

The application uses Serilog for logging. Logs are configured in appsettings.json and can be customized as needed.

{
  "Serilog": {
    "Using": [ "Serilog.Sinks.Console" ],
    "MinimumLevel": {
      "Default": "Debug",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning",
        "Microsoft.AspNetCore.Components": "Warning" // Suppress Blazor logs
      }
    },
    "WriteTo": [
      {
        "Name": "Console",
        "Args": {
          "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {SourceContext}: {Message:lj}{NewLine}{Exception}"
        }
      }
    ],
    "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ]
  }
}