Weather App C# .NET Core TDD Clean Architecture

A sample project (Weather App) built with C# .NET Core using CQRS Pattern, TDD and Clean Architecture

Installation

• Clone this Project
• Download and Install .NET Core SDK (3.1)
• Download and Install your favorite IDE (Visual Studio, Visual Studio Code, Rider)
• Copy/Move /WeatherApp.Web/example.appsettings.json to /WeatherApp.Web/appsettings.json, edit your BaseApiURL config

  "BaseApiURL": "http://localhost:5114"

• Copy/Move /WeatherApp.WebAPI/example.appsettings.json to /WeatherApp.WebAPI/appsettings.json, edit your ApiKey config

 "OpenWeatherMap": {
    "BaseApiURL": "http://api.openweathermap.org/data/2.5/",
    "ApiKey": "<your_own_key>"
  }

• and Connection Strings

  "ConnectionStrings": {
    "Sqlite": "Data Source=weather.db"
  },

• Publish this App using dotnet command

  dotnet publish

• Run Web API (with Swagger UI), with following command

  cd .\WeatherApp.WebAPI\bin\Debug\netcoreapp3.1\
  dotnet WeatherApp.WebAPI.dll

When Web API has started, you can access it in URL http://localhost:5114/ or access Swagger UI in http://localhost:5114/swagger/index.html

• Goto root folder solution (skip if you already in root folder solution)

  cd ..\..\..\..

• Run Web (Frontend), with following command

  cd .\WeatherApp.Web\bin\Debug\netcoreapp3.1\
  dotnet WeatherApp.Web.dll

When Web (Frontend) has started, you can access it in URL http://localhost:5000

Running Tests

To run tests, run the following command

  dotnet test

Notes

Because of OpenWeatherMap doesn't have an api to get country and city data, so I created sample data for countries and cities, namely

• For countries: Indonesia (ID), and Australia (AU)
• For cities in Indonesia: Bekasi, Bogor, Jakarta, Depok, Tangerang, South Tangerang
• For cities in Australia: Adelaide, Brisbane, Canberra, Darwin, Perth, Sydney

Also, I use the "cityName, countryCode" format in the "q" parameter in the weather api in OpenWeatherMap to increase accuracy because there are several city names that are the same in several countries. http://api.openweathermap.org/data/2.5/weather?q=cityName,countryCode

API Reference

Get All Country

You can get all country in database

  GET /country

Parameter
None

Example request :

  GET http://localhost:5114/country

This is sample body request (JSON) for this API

[
  {
    "id": "daa7e2cb-ec18-4ede-8bcf-bdb6df030d64",
    "code": "AU",
    "name": "Australia"
  },
  {
    "id": "da0b2d14-bf3e-43b4-911a-fc05574490fe",
    "code": "ID",
    "name": "Indonesia"
  }
]

Get All City By Country Code

You can get all city by country code in database

  GET /city/{countryCode}

Parameter	Type	Is Required	Description
countryCode	string of country code	Yes.	Country Code

Example request :

  GET http://localhost:5114/city/ID

This is sample body request (JSON) for this API

[
  {
    "id": "5331f925-4661-43c9-bc1b-91f78301ddb0",
    "countryCode": "ID",
    "name": "Bekasi",
    "lat": -6.2349,
    "lon": 106.9896
  },
  {
    "id": "b694c23e-76b2-4f32-853f-23cfa21a4937",
    "countryCode": "ID",
    "name": "Bogor",
    "lat": -6.5944,
    "lon": 106.7892
  },
  {
    "id": "ade68989-f876-42b9-a630-7170871549eb",
    "countryCode": "ID",
    "name": "Depok",
    "lat": -6.402484,
    "lon": 106.794243
  },
  {
    "id": "2c251bbc-e2fa-4788-91f9-976d0d05e741",
    "countryCode": "ID",
    "name": "Jakarta",
    "lat": -6.2146,
    "lon": 106.8451
  },
  {
    "id": "a91e6066-7dc2-4949-95b0-d3ad559d90bc",
    "countryCode": "ID",
    "name": "Tangerang",
    "lat": -6.1781,
    "lon": 106.63
  },
  {
    "id": "270e44e0-dacf-43b6-8bb3-e38db73f1539",
    "countryCode": "ID",
    "name": "Tangerang Selatan",
    "lat": -6.32674,
    "lon": 106.730042
  }
]

Get Weather Data By Country Code And City Name

You can get weather data in selected location (by country code and city name)

  GET /weather/{countryCode}/{cityName}

Parameter	Type	Is Required	Description
countryCode	string of country code	Yes.	Country Code
cityName	string of City Name	Yes.	City Name

Example request :

  GET http://localhost:5114/weather/query/ID/Tangerang%20Selatan

This is sample body request (JSON) for this API

{
  "location": {
    "lon": 106.7085,
    "lat": -6.2955,
    "countryId": "ID",
    "cityName": "Tangerang Selatan"
  },
  "time": 1698584569,
  "wind": {
    "speed": 5.75,
    "deg": 260,
    "gust": 0
  },
  "visibility": 5000,
  "skyConditions": {
    "id": 721,
    "main": "Haze",
    "description": "haze",
    "icon": "50n"
  },
  "temperatureFahrenheit": 87.58,
  "temperatureCelcius": 30.877777777777776,
  "dewPoint": 0,
  "relativeHumidity": 55,
  "pressure": 1009
}

Screenshots

Web

API (Swagger UI)

Tech Stack

Client: .NET Core Web (v3.1), Razor, jQuery, Bootstrap

Server: .NET Core Web API (v3.1), SqLite, Mediatr (CQRS)

Automation Test: Moq, xUnit, Shouldly

References

• Clean Architecture in ASP .NET Core Web API by @juldhais
• ASP.NET Core - Clean Architecture - Full Course by @trevoirwilliams
• Clean Architecture with .NET Core: Getting Started by @jasontaylordev
• How To Mock HttpClient in C# Unit Tests by @T0shik