https://github.com/kardelruveyda/dotnet-localization-example

A simple ASP.NET Core MVC example demonstrating how to implement multilingual support using IStringLocalizer and IViewLocalizer with .resx resource files.
https://github.com/kardelruveyda/dotnet-localization-example

dotnet dotnetcore localization mvc

Last synced: 11 months ago
JSON representation

A simple ASP.NET Core MVC example demonstrating how to implement multilingual support using IStringLocalizer and IViewLocalizer with .resx resource files.

• Host: GitHub
• URL: https://github.com/kardelruveyda/dotnet-localization-example
• Owner: KardelRuveyda
• Created: 2025-08-02T22:13:20.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-08-02T22:26:42.000Z (11 months ago)
• Last Synced: 2025-08-03T00:14:52.261Z (11 months ago)
• Topics: dotnet, dotnetcore, localization, mvc
• Language: HTML
• Homepage:
• Size: 1000 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 🌍 MultiLangDemo - ASP.NET Core Localization Example

MultiLangDemo is a sample ASP.NET Core MVC project that demonstrates how to implement **multi-language support** using `IStringLocalizer` and `IViewLocalizer`.

Users can view the site in their preferred language based on browser settings or a query string.

---

## 📁 Project Structure

```

MultiLangDemo/

├── Controllers/

│   └── HomeController.cs

├── Views/

│   └── Home/

│       └── Index.cshtml

├── Resources/

│   └── Views/

│       └── Home/

│           ├── Index.en-US.resx

│           ├── Index.tr-TR.resx

│           └── Index.de-DE.resx

├── Program.cs

├── MultiLangDemo.csproj

└── README.md

```

---

## 🚀 Getting Started

### ✅ Requirements

- [.NET 9 SDK](https://dotnet.microsoft.com/download)

- Visual Studio Code or Visual Studio 2022+

- Git (optional)

### 🔧 Setup Instructions

```bash

git clone https://github.com/yourusername/MultiLangDemo.git

cd MultiLangDemo

dotnet restore

dotnet run

```

The application will launch at:  

👉 https://localhost:5001

---

## 🌐 Testing Localization

You can switch the UI language by appending `?ui-culture=xx-XX` to the URL:

| Language | URL Example                                      |

|----------|--------------------------------------------------|

| 🇺🇸 English | `https://localhost:5001/?ui-culture=en-US`       |

| 🇹🇷 Turkish | `https://localhost:5001/?ui-culture=tr-TR`       |

| 🇩🇪 German  | `https://localhost:5001/?ui-culture=de-DE`       |

---

## 🧩 Key Concepts

- `IViewLocalizer`: Used in Razor Views to localize UI content.

- `IStringLocalizer`: Used in controllers or services to retrieve localized strings.

- `.resx` Files: Resource files that store key-value pairs for each supported culture.

---

## 💡 Sample Output

When visiting `https://localhost:5001/?ui-culture=tr-TR`:

```

Hoş geldiniz!

Aktif dil: tr-TR

```

When visiting `https://localhost:5001/?ui-culture=en-US`:

```

Welcome to our site!

Active culture: en-US

```

---

## ➕ Adding a New Language

To add support for French:

1. Create a new resource file:  

   `Resources/Views/Home/Index.fr-FR.resx`

2. Add translation keys and values:

| Name            | Value                      |

|-----------------|----------------------------|

| WelcomeMessage  | Bienvenue sur notre site   |

3. Add `fr-FR` to the supported cultures list in `Program.cs`.

---

## 🔒 Security Note

If you encounter a warning like:

```

Package 'System.Text.RegularExpressions' 4.3.0 has a known high severity vulnerability

```

You can upgrade the package using:

```bash

dotnet add package System.Text.RegularExpressions --version 4.3.1

```

---

## 📄 License

This project is licensed under the MIT License.