Mumrich.SpaDevMiddleware 1.2.1-PullRequest0012.21

Mumrich.SpaDevMiddleware

A .NET Middleware for ASP.NET Core 6 that automatically integrates (multiple) Single-Page-Apps in a .NET-Webhost.

• Automatic node-package install (npm/yarn/pnpm)
• SPAs are automatically built upon (dotnet publish triggers the build-script in package.json)
• Automatic path-mapping for the SPA by aid of the superb YARP
• SPA Hot-Reloading supported
• Custom-ENV-Variables can be passed to the Node-Instance via appsettings.json
• Usage of MSBUILD-Variables supported

Usage

1. Install the Mumrich.SpaDevMiddleware Nuget-Package into your Web-Project (.NET 6)

2. Implement the ISpaDevServerSettings-interface:

   public class AppSettings : ISpaDevServerSettings
   {
     public Dictionary<string, SpaSettings> SinglePageApps { get; set; } = new();
     public string SpaRootPath { get; set; } = Directory.GetCurrentDirectory();
     public bool UseParentObserverServiceOnWindows { get; set; } = false;
   }
   

3. Extend appsettings.json with a SPA-Config e.g.:

   {
     "Logging": {
       "LogLevel": {
         "Default": "Information",
         "Microsoft.AspNetCore": "Warning"
       }
     },
     "AllowedHosts": "*",
     "SinglePageApps": {
       "/": {
         "DevServerAddress": "http://localhost:3000/",
         "SpaRootPath": "app1",
         "NodePackageManager": "Yarn",
         "NodeStartScript": "dev",
         "NodeBuildScript": "build",
         "Regex": "dev server running at:",
         "Bundler": "ViteJs",
         "Environment": {
           "HMR_PORT": "%ASPNETCORE_HTTPS_PORT%",
           "HMR_PROTOCOL": "wss"
         }
       },
       "/admin": {
         "DevServerAddress": "http://localhost:9000/",
         "SpaRootPath": "app2",
         "NodePackageManager": "Yarn",
         "NodeStartScript": "dev",
         "Regex": "Opening default browser",
         "Bundler": "ViteJs"
       }
     }
   }
   

4. Register Services and setup app e.g.:

   using Mumrich.SpaDevMiddleware.Extensions;
   
   var builder = WebApplication.CreateBuilder(args);
   var appSettings = builder.Configuration.Get<AppSettings>();
   
   builder.Services.AddControllersWithViews();
   builder.Services.AddCors();
   builder.RegisterSinglePageAppDevMiddleware(appSettings);
   
   var app = builder.Build();
   
   app.UseStaticFiles();
   app.UseHttpsRedirection();
   app.UseRouting();
   app.UseCors();
   app.MapControllers();
   app.MapSinglePageApps(appSettings);
   
   app.Run();
   

5. When using hot-reloading, adapt your SPA-bundling-setup accordingly to accept the .NET-Webhost-Proxy on the correct Port. Custom-ENV-Variables can be passed via appsettings.json - e.g for vite.config.ts:

   const protocol = process.env.HMR_PROTOCOL ?? "ws";
   const port = Number(process.env.HMR_PORT) ?? 3000;
   
   // https://vitejs.dev/config/
   export default defineConfig({
     plugins: [vue()],
     server: {
       port: 3000,
       strictPort: true,
       hmr: {
         protocol,
         port,
       },
     },
   });
   

6. Run the app (dotnet run), navigate to the .NET-Web-host-Url and enjoy 👌!

Troubleshooting

• See the working Example in the WebSpaVue-folder.

Credits

• Thx to aspnetcore-vueclimiddleware for providing insights how to handle console-output.
• Thx to AspNetCore.SpaYarp for providing idea and insights to use YARP.
• Thx to YARP for providing such a wonderfull tool.