Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/EEParker/aspnetcore-vueclimiddleware
Helpers for building single-page applications on ASP.NET MVC Core using Vue Cli or Quasar Cli.
https://github.com/EEParker/aspnetcore-vueclimiddleware
aspnet aspnetcore dotnet quasar-cli quasar-framework vue-cli
Last synced: 3 months ago
JSON representation
Helpers for building single-page applications on ASP.NET MVC Core using Vue Cli or Quasar Cli.
- Host: GitHub
- URL: https://github.com/EEParker/aspnetcore-vueclimiddleware
- Owner: EEParker
- License: other
- Archived: true
- Created: 2018-09-20T22:09:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T19:12:37.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T21:37:12.026Z (4 months ago)
- Topics: aspnet, aspnetcore, dotnet, quasar-cli, quasar-framework, vue-cli
- Language: C#
- Homepage:
- Size: 4.83 MB
- Stars: 338
- Watchers: 14
- Forks: 65
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# VueCliMiddleware - Supporting Vue Cli and Quasar Cli
[](https://www.nuget.org/packages/VueCliMiddleware/)
This is a stand-alone module to add Vue Cli and Quasar Cli support to AspNet Core.
See the examples here: [https://github.com/EEParker/aspnetcore-vueclimiddleware/tree/master/samples](https://github.com/EEParker/aspnetcore-vueclimiddleware/tree/master/samples)
## ASP.NET 3.X Endpoint Routing
First, be sure to switch Vue Cli or Quasar Cli to output distribution files to wwwroot directly (not dist).
* Quasar CLI: regex: "Compiled successfully"
* Vue CLI: regex: "Compiled successfully" or "running at" or "Starting development server" depending on version
>the reason for **`Starting development server`** ,the npm-script running checkpoint:
Although the dev server may eventually tell us the URL it's listening on,
it doesn't do so until it's finished compiling, and even then only if there were
no compiler warnings. So instead of waiting for that, consider it ready as soon
as it starts listening for requests.[see the codes](https://github.com/EEParker/aspnetcore-vueclimiddleware/blob/master/src/VueCliMiddleware/VueDevelopmentServerMiddleware.cs#L91)
## Configuration Options
When using the `MapToVueCliProxy` or `UseVueCli` you can customize the behavior based on your npm script runner or compiler.
| Parameter | Type | Description | Default |
|-----------|------|-------------|---------|
|`npmScript`|string|The name of the script in your package.json file that launches the vue-cli, quasar cli or other web server.||
|`spaOptions`|[SpaOptions](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.spaservices.spaoptions?view=aspnetcore-5.0)|Set the folder of the app to be proxied.||
|`port`|int|Specify the vue cli server port number. This is also used by the force-kill option to discover processes utilizing the port.|8080|
|`https`|bool|Set proxy to use https|false|
|`runner`|`enum { Npm, Yarn }`|Specify the runner, Npm and Yarn are valid options. Yarn support is experimental.|Npm|
|`regex`|string|**IMPORTANT** Text to search in npm log that indicates web server is running. This **MUST BE SET** for vue-cli, quasar and quasar v2. (e.g. `running at`, `READY`, `APP Url`)|`running at`|
|`forceKill`|bool|Attempt to kill the npm process when stopping debugging.|false|
|`wsl`|bool|Set to true if you are using WSL on windows. For other operating systems it will be ignored. This changes the executed process name to `wsl` instead of `cmd`.|false|
See [Migrating Asp.Net 2.2 to 3.0 Endpoint Routing](https://docs.microsoft.com/en-us/aspnet/core/migration/22-to-30?view=aspnetcore-3.1&tabs=visual-studio#update-routing-startup-code)
```csharp
public class Startup {
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
// NOTE: PRODUCTION Ensure this is the same path that is specified in your webpack output
services.AddSpaStaticFiles(opt => opt.RootPath = "ClientApp/dist");
services.AddControllers();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// optional base path for IIS virtual app/directory
app.UsePathBase("/optionalpath");
// PRODUCTION uses webpack static files
app.UseSpaStaticFiles();
// Routing
app.UseRouting();
app.UserAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
endpoints.MapToVueCliProxy(
"{*path}",
new SpaOptions { SourcePath = "ClientApp" },
npmScript: (System.Diagnostics.Debugger.IsAttached) ? "serve" : null,
regex: "Compiled successfully",
forceKill: true,
wsl: false // Set to true if you are using WSL on windows. For other operating systems it will be ignored
);
});
}
}
```
## ASP.NET 2.2 Usage Example
```csharp
using VueCliMiddleware;
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
public virtual void ConfigureServices(IServiceCollection services)
{
services.AddMvc(); // etc
// Need to register ISpaStaticFileProvider for UseSpaStaticFiles middleware to work
services.AddSpaStaticFiles(configuration => { configuration.RootPath = "ClientApp/dist"; });
}
public virtual void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
// your config opts...
// optional basepath
// app.UsePathBase("/myapp");
// add static files from SPA (/dist)
app.UseSpaStaticFiles();
app.UseMvc(routes => /* configure*/ );
app.UseSpa(spa =>
{
spa.Options.SourcePath = "ClientApp";
#if DEBUG
if (env.IsDevelopment())
{
spa.UseVueCli(npmScript: "serve", port: 8080); // optional port
}
#endif
});
}
}
```
## CSPROJ Configuration
You may also need to add the following tasks to your csproj file. This are similar to what are found in the default ASPNETSPA templates.
```project.csproj
ClientApp\
$(DefaultItemExcludes);$(SpaRoot)node_modules\**
%(DistFiles.Identity)
PreserveNewest
```
## History
Due to the discussion [here](https://github.com/aspnet/JavaScriptServices/pull/1726), it was decided to not be included in the Microsoft owned package.