Oqtane Framework
Oqtane is a Modular Application Framework for Blazor
Oqtane uses Blazor, a new web framework for .NET Core that lets you build interactive web UIs using C# instead of JavaScript. Blazor apps are composed of reusable web UI components implemented using C#, HTML, and CSS. Both client and server code is written in C#, allowing you to share code and libraries.
To get started with Oqtane:
1. Install .NET Core 3.1 SDK.
2. Install the latest edition of Visual Studio 2019 (version 16.4 or higher) with the ASP.NET and web development workload. If you do not have a SQL Server installation available already and you wish to use LocalDB for development, you must also install the .NET desktop development workload.
3. Download or Clone the Oqtane source code to your local system. Open the Oqtane.sln solution file. If you want to develop using server-side Blazor (which includes a full debugging experience in Visual Studio) you should choose to Build the solution using the default Debug configuration. If you want to develop using client-side Blazor (WebAssembly) you should first choose the "Wasm" configuration option in the Visual Studio toolbar and then Build.
NOTE: If you have already installed a previous version of Oqtane and you wish to install a newer version, there is currently no upgrade path from one version to the next. The recommended upgrade approach is to get the latest code and build it, and then reset the DefaultConnection value to "" in the appsettings.json file in the Oqtane.server project. This will trigger a re-install when you run the application which will execute the latest database scripts.
NOTE: If you want to submit pull requests make sure you install the Github Extension For Visual Studio. It is recommended you ignore any local changes you have made to the appsettings.json file before you submit a pull request. To automate this activity, open a command prompt and navigate to the /Oqtane.Server/ folder and enter the command "git update-index --skip-worktree appsettings.json"
Roadmap
This project is a work in progress and the schedule for implementing enhancements is dependent upon the availability of community members who are willing/able to assist.
V1 (MVP)
- Multi-Tenant ( Shared Database & Isolated Database )
- Modular Architecture / Headless API
- Dynamic Page Compositing Model / Site & Page Management
- Authentication / User Management / Profile Management
- Authorization / Roles Management / Granular Permissions
- Dynamic Routing
- Extensibility via Custom Modules
- Extensibility via Custom Themes
- Event Logging
- Folder / File Management
- Recycle Bin
- Scheduled Jobs ( Background Processing )
- Notifications / Email Delivery
- Auto-Upgrade Framework
V.Next
- Optional Encryption of Settings Values ( ie. via an IsSecure flag )
- Localization
- Migrate to Code-Behind Pattern ( *.razor.cs )
- Generic Repository Pattern
- JwT token authentication
Background
Oqtane was created by Shaun Walker and is inspired by the DotNetNuke web application framework. Initially created as a proof of concept, Oqtane is a native Blazor application written from the ground up using modern .NET Core technology. It is a modular application framework offering a fully dynamic page compositing model, multi-site support, designer friendly templates (skins), and extensibility via third party modules.
Release Announcement
Announcing Oqtane... a Modular Application Framework for Blazor!
Example Screenshots
Install Wizard:
Default view after installation:
A seamless login flow utilizing .NET Core Identity services:
Main view for authorized users, allowing full management of modules and content:
Content editing user experience using modal dialog:
Context menu for managing specific module on page:
Control panel for adding, editing, and deleting pages as well as adding new modules to a page:
Admin dashboard for accessing the variuous administrative features of the framework:
