You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Build cross platform desktop apps with .NET Core 3.1 and ASP.NET NET Core.
12
+
Build cross platform desktop apps with .NET Core 3.1 and ASP.NET NET Core (Razor Pages, MVC), Blazor.
13
13
14
14
Electron.NET is a __wrapper__ around a "normal" Electron application with an embedded ASP.NET Core application. Via our Electron.NET IPC bridge we can invoke Electron APIs from .NET.
15
15
@@ -19,24 +19,28 @@ The CLI extensions hosts our toolset to build and start Electron.NET application
19
19
20
20
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.
21
21
22
-
# NuGet:
22
+
# 📦 NuGet:
23
23
24
24
* API [](https://www.nuget.org/packages/ElectronNET.API/)
The current Electron.NET CLI builds Windows/macOS/Linux binaries. Our API uses .NET Core 3.1, so our minimum base OS is the same as [.NET Core 3.1](https://github.com/dotnet/core/blob/master/release-notes/3.1/3.1-supported-os.md).
We do this open source work in our free time. If you'd like us to invest more time on it, please [donate](https://donorbox.org/electron-net). Donation can be used to increase some issue priority. Thank you!
42
+
43
+
# 👩🏫 Usage
40
44
41
45
To activate and communicate with the "native" (sort of native...) Electron API include the [ElectronNET.API NuGet package](https://www.nuget.org/packages/ElectronNET.API/) in your ASP.NET Core app.
42
46
@@ -71,7 +75,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
71
75
}
72
76
```
73
77
74
-
## Start the Application
78
+
## 🚀 Start the Application
75
79
76
80
To start the application make sure you have installed the "[ElectronNET.CLI](https://www.nuget.org/packages/ElectronNET.CLI/)" packages as global tool:
77
81
@@ -95,7 +99,7 @@ electronize start
95
99
### Note
96
100
> Only the first electronize start is slow. The next will go on faster.
97
101
98
-
## Develop Electron.NET apps using a file watcher
102
+
## 🔭 Develop Electron.NET apps using a file watcher
99
103
100
104
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:
101
105
@@ -106,19 +110,19 @@ electronize start /watch
106
110
### Note
107
111
> Only the first electronize start is slow. The next will go on faster.
108
112
109
-
## Debug
113
+
## 🐞 Debug
110
114
111
115
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.
112
116
113
117
114
-
## Usage of the Electron-API
118
+
## 📔 Usage of the Electron-API
115
119
116
120
A complete documentation will follow. Until then take a look in the source code of the sample application:
117
121
[Electron.NET API Demos](https://github.com/ElectronNET/electron.net-api-demos)
118
122
119
123
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](https://www.youtube.com/watch?v=nuM6AojRFHk)
120
124
121
-
## Build
125
+
## ⛏ Build
122
126
123
127
Here you need the Electron.NET CLI as well. Type the following command in your ASP.NET Core folder:
124
128
@@ -147,35 +151,36 @@ The end result should be an electron app under your __/bin/desktop__ folder.
147
151
### Note
148
152
> macOS builds can't be created on Windows machines because they require symlinks that aren't supported on Windows (per [this Electron issue](https://github.com/electron-userland/electron-packager/issues/71)). macOS builds can be produced on either Linux or macOS machines.
149
153
150
-
# Working with this Repo
154
+
# 👨💻 Authors
155
+
156
+
***Gregor Biswanger** - (Microsoft MVP, Intel Black Belt and Intel Software Innovator) is a freelance lecturer, consultant, trainer, author and speaker. He is a consultant for large and medium-sized companies, organizations and agencies for software architecture, web- and cross-platform development. You can find Gregor often on the road attending or speaking at international conferences. - [Cross-Platform-Blog](http://www.cross-platform-blog.com) - Twitter [@BFreakout](https://www.twitter.com/BFreakout)
157
+
***Robert Muehsig** - Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek. - [codeinside Blog](https://blog.codeinside.eu) - Twitter [@robert0muehsig](https://twitter.com/robert0muehsig)
158
+
159
+
See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project.
160
+
161
+
162
+
# 🙋♀️🙋♂ Contributing
163
+
Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the [Issues section](https://github.com/ElectronNET/Electron.NET/issues).
164
+
Please make sure all commits are properly documented.
165
+
166
+
# 🧪 Working with this Repo
151
167
152
168
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 buildAll scripts (.cmd for Windows, the other for macOS/Linux).
153
169
154
170
If you look for pure __[demo projects](https://github.com/ElectronNET)__ checkout the other repositories.
155
171
156
172
The problem working with this repository is, that NuGet has a pretty aggressive cache, see [here for further information](https://github.com/ElectronNET/Electron.NET/wiki).
157
173
158
-
# Contributing
159
-
Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the [Issues section](https://github.com/ElectronNET/Electron.NET/issues).
160
-
Please make sure all commits are properly documented.
161
-
162
-
# Authors
163
-
164
-
***Gregor Biswanger** - (Microsoft MVP, Intel Black Belt and Intel Software Innovator) is a freelance lecturer, consultant, trainer, author and speaker. He is a consultant for large and medium-sized companies, organizations and agencies for software architecture, web- and cross-platform development. You can find Gregor often on the road attending or speaking at international conferences. - [Cross-Platform-Blog](http://www.cross-platform-blog.com) - Twitter [@BFreakout](https://www.twitter.com/BFreakout)
165
-
***Robert Muehsig** - Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek. - [codeinside Blog](https://blog.codeinside.eu) - Twitter [@robert0muehsig](https://twitter.com/robert0muehsig)
166
-
167
-
See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project.
168
-
169
-
# Donate
174
+
# 🙏 Donate
170
175
171
176
We do this open source work in our free time. If you'd like us to invest more time on it, please [donate](https://donorbox.org/electron-net). Donation can be used to increase some issue priority. Thank you!
172
177
173
-
# License
178
+
# 🎉 License
174
179
MIT-licensed
175
180
176
181
**Enjoy!**
177
182
178
-
# Important notes
183
+
# 📝 Important notes
179
184
180
185
## ElectronNET.API & ElectronNET.CLI Version 8.31.1
0 commit comments