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
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,35 +19,35 @@ 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
42
43
-
# 👩🏫 Usage
43
+
##👩🏫 Usage
44
44
45
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.
46
46
47
47
````
48
48
PM> Install-Package ElectronNET.API
49
49
````
50
-
## Program.cs
50
+
###Program.cs
51
51
52
52
You start Electron.NET up with an `UseElectron` WebHostBuilder-Extension.
53
53
@@ -61,7 +61,7 @@ You start Electron.NET up with an `UseElectron` WebHostBuilder-Extension.
61
61
});
62
62
```
63
63
64
-
## Startup.cs
64
+
###Startup.cs
65
65
66
66
Open the Electron Window in the Startup.cs file:
67
67
@@ -151,38 +151,38 @@ The end result should be an electron app under your __/bin/desktop__ folder.
151
151
### Note
152
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.
153
153
154
-
# 👨💻 Authors
154
+
##👨💻 Authors
155
155
156
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
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
158
159
159
See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project.
160
160
161
161
162
-
# 🙋♀️🙋♂ Contributing
162
+
##🙋♀️🙋♂ Contributing
163
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
164
Please make sure all commits are properly documented.
165
165
166
-
# 🧪 Working with this Repo
166
+
##🧪 Working with this Repo
167
167
168
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).
169
169
170
170
If you look for pure __[demo projects](https://github.com/ElectronNET)__ checkout the other repositories.
171
171
172
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).
173
173
174
-
# 🙏 Donate
174
+
##🙏 Donate
175
175
176
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!
177
177
178
-
# 🎉 License
178
+
##🎉 License
179
179
MIT-licensed
180
180
181
181
**Enjoy!**
182
182
183
-
# 📝 Important notes
183
+
##📝 Important notes
184
184
185
-
## ElectronNET.API & ElectronNET.CLI Version 8.31.1
185
+
###ElectronNET.API & ElectronNET.CLI Version 8.31.1
186
186
187
187
Make sure you also have the new Electron.NET API & CLI 8.31.1 version.
In the Version 0.0.9 the CLI was not a global tool and needed to be registred like this in the .csproj:
235
235
@@ -252,7 +252,7 @@ If you still use this version you will need to invoke it like this:
252
252
electronize ...
253
253
```
254
254
255
-
## Node Integration
255
+
###Node Integration
256
256
Electron.NET requires Node Integration to be enabled for IPC to function. If you are not using the IPC functionality you can disable Node Integration like so:
0 commit comments