Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 44 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,58 @@
# Syncfusion Blazor Server Side application on Electron
# Blazor Electron App

A demonstration of integrating [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](https://www.syncfusion.com/blazor-components) with the **Electron** framework to build modern desktop applications.

## Overview

This project showcases how to build robust desktop applications by combining:

- **Blazor Server** - For building interactive web-based UIs using C# and Razor components
- **Electron** - For packaging and deploying as native desktop applications
- **Syncfusion Blazor Components** - For rich, enterprise-grade UI controls including grids, charts, and more

## Features

- **Desktop-ready** - Seamless Electron integration for native app experience
- **Syncfusion UI components** - Pre-configured with Syncfusion Blazor Grid and Themes
- **Cross-platform** - Build for Windows, macOS, and Linux (x64, ARM64)
- **Modern Blazor** - Interactive server rendering and real-time component updates

## Prerequisites

* [NET Core SDK 3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1) or [.NET 6.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
Before you get started, ensure you have the following installed:

* [Node.js](https://nodejs.org/en/)
- [.NET SDK 10.0](https://dotnet.microsoft.com/download/dotnet)
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or later
- [Visual Studio Code](https://code.visualstudio.com/)
- [Node.js](https://nodejs.org) (v14 or later) - Required by ElectronNET

## Running the application
## Getting Started

* Open command prompt and clone the repository using below command line.
### Clone the Repository

```
```bash
git clone https://github.com/SyncfusionExamples/blazor-electron-app
cd blazor-electron-app
```

* Navigate into application .csproj folder and run the application using below command line.
### Run with Visual Studio

1. Open the solution file using Visual Studio 2022 or later.
2. Restore the NuGet packages by rebuilding the solution.
3. Build the project to ensure there are no compilation errors.
4. Run the project.

### Run with .NET CLI

```bash
# Restore dependencies
dotnet restore

# Run the project
dotnet run
```
cd blazor-electron-app
cd NET3.1 [for .NET 3.1 application] / cd NET6 [for .NET 6.0 application]
dotnet electronize start
```

* The application will launch on Electron shell.
## References

- [ElectronNET Guide](https://github.com/ElectronNET/Electron.NET)
- [Electron framework documentation](https://www.electronjs.org/docs)