Skip to content

Latest commit

 

History

History
326 lines (214 loc) · 12.6 KB

README.md

File metadata and controls

326 lines (214 loc) · 12.6 KB
Raw

Electron.NET Logo

donate Gitter Build status

Build cross platform desktop apps with .NET 8 and Blazor, ASP.NET Core (Razor Pages, MVC).

Electron.NET is a wrapper around a native Electron application with an embedded ASP.NET Core application. Via our Electron.NET IPC bridge we can invoke Electron APIs from .NET.

The CLI extensions hosts our toolset to build and start Electron.NET applications.

Wait - you host a .NET Core app inside Electron? Why?

Well... there are lots of different approaches how to get a X-plat desktop app running. We thought it would be nice for .NET devs to use the ASP.NET Core environment and just embed it inside a pretty robust X-plat enviroment called Electron. Porting Electron to .NET is not a goal of this project, at least we don't have any clue how to do it. We just combine ASP.NET Core & Electron.

📦 NuGet

NuGet ElectronNET.API | NuGet ElectronNET.CLI

🛠 Requirements to Run

The current Electron.NET CLI builds Windows/macOS/Linux binaries. Our API uses .NET 8, so our minimum base OS is the same as .NET 8.

Also you should have installed:

💬 Community

Gitter

Besides the chat on Gitter and the issues discussed here you can also use StackOverflow with the tag electron.net.

If you want to sponsor the further maintenance and development of this project see the donate section.

👩‍🏫 Usage

To activate and communicate with the "native" (sort of native...) Electron API include the ElectronNET.API NuGet package in your ASP.NET Core app.

PM> Install-Package ElectronNET.API

Setup Using Minimal-API

You start Electron.NET up with an UseElectron WebHostBuilder-Extension and open the Electron Window:

Program.cs

using ElectronNET.API;
using ElectronNET.API.Entities;

var builder = WebApplication.CreateBuilder(args);
builder.WebHost.UseElectron(args);

// Is optional, but you can use the Electron.NET API-Classes directly with DI (relevant if you want more encoupled code)
builder.Services.AddElectron();

var app = builder.Build();

...

await app.StartAsync();

// Open the Electron-Window here
await Electron.WindowManager.CreateWindowAsync();

app.WaitForShutdown();

Setup using Normal-API

Program.cs

You start Electron.NET up with an UseElectron WebHostBuilder-Extension.

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseElectron(args);
            webBuilder.UseStartup<Startup>();
        });

Startup.cs

Open the Electron Window in the Startup.cs file:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    //...

    Electron.WindowManager.CreateWindowAsync();
}

🚀 Starting the Application

To start the application make sure you have installed the "ElectronNET.CLI" packages as global tool:

dotnet tool install ElectronNET.CLI -g

At the first time, you need an Electron.NET project initialization. Type the following command in your ASP.NET Core folder:

electronize init
  • Now a electronnet.manifest.json should appear in your ASP.NET Core project
  • Now run the following:
electronize start

Note

Only the first electronize start is slow. The next will go on faster.

🔭 Develop Electron.NET apps using a file watcher

The file watcher is included with version 8.31.1 of Electron.NET. For example, a file change can trigger compilation, test execution, or deployment. The Electron.NET window will automatically refresh and new code changes will be visible more quickly. The following Electron.NET CLI command is required:

electronize start /watch

Note

Only the first electronize start is slow. The next will go on faster.

🐞 Debugging the Application

Start your Electron.NET application with the Electron.NET CLI command. In Visual Studio attach to your running application instance. Go in the Debug Menu and click on Attach to Process.... Sort by your projectname on the right and select it on the list.

📔 Usage of the Electron API

A complete documentation will follow. Until then take a look in the source code of the sample application:
Electron.NET API Demos

In this YouTube video, we show you how you can create a new project, use the Electron.NET API, debug a application and build an executable desktop app for Windows: Electron.NET - Getting Started

⛏ Building Release Artifacts

Here you need the Electron.NET CLI as well. Type the following command in your ASP.NET Core folder:

electronize build /target win

There are additional platforms available:

electronize build /target win
electronize build /target osx
electronize build /target linux

Those three "default" targets will produce x64 packages for those platforms.

For certain NuGet packages or certain scenarios you may want to build a pure x86 application. To support those things you can define the desired .NET Core runtime, the electron platform and electron architecture like this:

electronize build /target custom "win7-x86;win32" /electron-arch ia32

The end result should be an electron app under your /bin/desktop folder.

Note

macOS builds can't be created on Windows machines because they require symlinks that aren't supported on Windows (per this Electron issue). macOS builds can be produced on either Linux or macOS machines.

🔄 Update

After an update to the latest Electron.API package, an update to the latest Electron.CLI is always required. In addition, always update the CLI via NuGet:

dotnet tool update ElectronNET.CLI -g

👨‍💻 Authors

See also the list of contributors who participated in this project.

🙋‍♀️🙋‍♂ Contributing

Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the Issues section. Please make sure all commits are properly documented.

🧪 Working with this Repo

This video provides an introduction to development for Electron.NET: Electron.NET - Contributing Getting Started

This repository consists of the main parts (API & CLI) and it's own "playground" ASP.NET Core application. Both main parts produce local NuGet packages, that are versioned with 99.0.0. The first thing you will need is to run one of the build scripts (.cmd or .ps1 for Windows, the .sh for macOS/Linux).

If you look for pure demo projects checkout the other repositories.

The problem working with this repository is, that NuGet has a pretty aggressive cache, see here for further information.

🙏 Donate

We do this open source work in our free time. If you'd like us to invest more time on it, please donate. Donation can be used to increase some issue priority. Thank you!

donate

Alternatively, consider using a GitHub sponsorship for the core maintainers:

Any support appreciated! 🍻

🎉 License

MIT-licensed. See LICENSE for details.

Enjoy!

📝 Important notes

ElectronNET.API & ElectronNET.CLI Version 9.31.2

Make sure you also have the new Electron.NET API & CLI 9.31.2 version.

dotnet tool update ElectronNET.CLI -g

This now uses electron-builder and the necessary configuration to build is made in the electron.manifest.json file (on the build part). In addition, own Electron.NET configurations are stored (on the root).

Please make sure that your electron.manifest.json file has the following new structure:

{
  "executable": "{{executable}}",
  "splashscreen": {
    "imageFile": ""
  },
  "name": "{{executable}}",
  "author": "",
  "singleInstance": false,
  "build": {
    "appId": "com.{{executable}}.app",
    "productName": "{{executable}}",
    "copyright": "Copyright © 2020",
    "buildVersion": "1.0.0",
    "compression": "maximum",
    "directories": {
      "output": "../../../bin/Desktop"
    },
    "extraResources": [
      {
        "from": "./bin",
        "to": "bin",
        "filter": ["**/*"]
      }
    ],
    "files": [
      {
        "from": "./ElectronHostHook/node_modules",
        "to": "ElectronHostHook/node_modules",
        "filter": ["**/*"]
      },
      "**/*"
    ]
  }
}

ElectronNET.CLI Version 0.0.9

In the Version 0.0.9 the CLI was not a global tool and needed to be registered like this in the .csproj:

<ItemGroup>
  <DotNetCliToolReference Include="ElectronNET.CLI" Version="0.0.9" />
</ItemGroup>

After you edited the .csproj file, you need to restore your NuGet packages within your Project. Run the following command in your ASP.NET Core folder:

dotnet restore

If you still use this version you will need to invoke it like this:

electronize ...

Node.js Integration

Electron.NET requires Node.js integration to be enabled for IPC to function. If you are not using the IPC functionality you can disable Node.js integration like so:

WebPreferences wp = new WebPreferences();
wp.NodeIntegration = false;
BrowserWindowOptions browserWindowOptions = new BrowserWindowOptions
{
    WebPreferences = wp
};

Dependency Injection

ElectronNET.API can be added to your DI container within the Startup class. All of the modules available in Electron will be added as Singletons.

using ElectronNET.API;

public void ConfigureServices(IServiceCollection services)
{
    services.AddElectron();
}