PluginCore-main.zip

<p align="center"> <img src="docs/docs/.vuepress/public/images/logo.png" alt="PluginCore"> </p> <h1 align="center">PluginCore</h1> English | [中文](README_zh.md) > 🔌 `ASP.NET Core` lightweight plugin framework | ASP.NET Core 轻量级 插件框架 - 一分钟集成 | Vue.js frontend | JavaScript SDK []() [](https://github.com/yiyungent/PluginCore/blob/main/LICENSE) [](https://www.codefactor.io/repository/github/yiyungent/plugincore) [](https://www.nuget.org/packages/PluginCore/) [](https://jq.qq.com/?_wv=1027&k=q5R82fYN) [](https://t.me/xx_dev_group) <!--  --> [](https://cla-assistant.io/yiyungent/PluginCore) [](https://app.fossa.com/projects/git%2Bgithub.com%2Fyiyungent%2FPluginCore?ref=badge_shield) ## Introduce 🔌 `ASP.NET Core` lightweight plugin framework | ASP.NET Core 轻量级 插件框架 - 一分钟集成 | Vue.js frontend | JavaScript SDK - **Simple** - Agreement is better than configuration, with minimal configuration to help you focus on your business - **Out of the box** - Automatic front-end and back-end integration, two lines of code complete the integration - **Dynamic WebAPI** - Each plug-in can add a Controller and have its own routing - **Plugin isolation and sharing** - Perfect plugin isolation and type sharing - **Front and back ends of the plug-in are separated** - You can place the front-end files (index.html,...) under the plugin `wwwroot` folder, and then visit `/plugins/pluginId/index.html` - **Hot swap** - Upload, install, enable, disable, uninstall, and delete without restarting the site; you can even add the `HTTP request pipeline middleware` at runtime through the plug-in, and there is no need to restart the site - **Dependency injection** - You can apply for dependency injection in the construction method of the plug-in class that implements IPlugin. Of course, dependency injection can also be used in the controller construction method - **Modular** - Process modularization, full dependency injection, can be implemented by replacement to customize the plug-in mechanism - **Easy to expand** - You can write your own plug-in SDK, then reference the plug-in SDK, write extension plug-ins-custom plug-in hooks, and apply - **Plugin dependency tree** - Declarative dependencies, automatically establish the correct loading order according to the dependencies between plugins - **Life cycle** - Controllable plug-in life cycle, perfect event distribution - **Widget** - You can bury extension points in the front end, inject widgets through plug-ins, widgets have perfect HTML/CSS/JavaScript support, and elegant event dispatch - **No database required** - No database dependency - **0 intrusion** - Nearly zero intrusion, does not affect your existing system - **Little reliance** - Only rely on a third-party package (`SharpZipLib` for decompression) - **Globalization** - Thanks to the internationalization implementation of `i18n`, it provides multi-language switching support ## Online demo - [https://knifehub.onrender.com](https://knifehub.onrender.com) - Username: admin Password: ABC12345 - Online demo, use [KnifeHub](https://github.com/yiyungent/KnifeHub), empty data from time to time - Not the latest version ## Tech Stack - Backend: .NET/C#: .NET Standard & .NET Core & .NET & ASP.NET Core - Frontend: Vue.js & vue-i18n & Vue Router & Vuex & Element UI - Frontend: babel & mockjs & sass & autoprefixer & eslint & axios & npm > 关联线上产品: > - [https://120365.xyz](https://120365.xyz) > - 在线工具集 > - 数据分析可视化 > - 时间管理 > - 效率工具箱 ## Screenshot     ## One minute integration Recommended Use [NuGet](https://www.nuget.org/packages/PluginCore), Execute the following commands in the root directory of your project. If you use Visual Studio, then click **Tools** -> **NuGet Package Manager** -> **Package Manager Console**, make sure "Default project" It is the item you want to install, enter the command below to install it. ### ASP.NET Core Project ```bash PM> Install-Package PluginCore.AspNetCore ``` > Modify the code in your ASP.NET Core application > > Startup.cs ```C# using PluginCore.AspNetCore.Extensions; // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.AddControllers(); // 1. Add PluginCore services.AddPluginCore(); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseHttpsRedirection(); app.UseRouting(); // 2. Use PluginCore app.UsePluginCore(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); } ``` > Now visit https://localhost:5001/PluginCore/Admin to enter PluginCore Admin > https://localhost:5001 Need to be changed to your address ### Notice Please log in to `PluginCore Admin`, and for safety, modify the default user name and password in time: `App_Data/PluginCore.Config.json` ```json { "Admin": { "UserName": "admin", "Password": "ABC12345" }, "FrontendMode": "LocalEmbedded", "RemoteFrontend": "https://cdn.jsdelivr.net/gh/yiyungent/plugincore-admin-frontend@0.1.2/dist-cdn" } ``` After the modification, it will take effect immediately, no need to restart the site, you need to log in to `PluginCore Admin` again ## Docker experience If you need to experience PluginCore locally, then here is an [example(/examples)](https://github.com/yiyungent/PluginCore/tree/main/examples) ```bash docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" --name plugincore-aspnetcore3-1 yiyungent/plugincore-aspnetcore3-1 ``` Now you can visit http://localhost:5004/PluginCore/Admin > add: > If you use `Docker Compose`, you can refer to `docker-compose.yml` in the root directory of the warehouse > add: > Use `ghcr.io` > > ```bash > docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" --name plugincore-aspnetcore3-1 ghcr.io/yiyungent/plugincore-aspnetcore3-1 > ``` ## Use - [Detailed Documentation(/docs)](https://yiyungent.github.io/PluginCore "Online Documentation") Document is under construction - [API Docs](https://yiyungent.github.io/PluginCore/docs-api/api/index.html "API Docs") automatic update - [See examples(/examples)](https://github.com/yiyungent/PluginCore/tree/main/examples) ### Add plugin hook and apply > 1. For example, custom plug-in hook: `ITestPlugin` ```C# using PluginCore.IPlugins; namespace PluginCore.IPlugins { public interface ITestPlugin : IPlugin { string Say(); } } ``` > 2. Apply the hook where it needs to be activated, so that all enabled plug-ins that implement `ITestPlugin` will call `Say()` ```C# using PluginCore; using PluginCore.IPlugins; namespace WebApi.Controllers { [Route("api/[controller]")] [ApiController] public class TestController : ControllerBase { private readonly PluginFinder _pluginF