/oqtane.framework

Modular Application Framework for Blazor

Primary LanguageC#MIT LicenseMIT

Oqtane Framework

Oqtane is a Modular Application Framework for Blazor

Oqtane

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. Oqtane is currently compatible with .NET Core 3.0 Preview 6 SDK (3.0.0-preview6.19307.2). Microsoft continues to release new versions of .NET Core 3.0 on a regular basis and we do our best to keep up; however, for the best results you should use the most compatible .NET Core 3.0 version.

2. Install the latest Preview edition of Visual Studio 2019 with the ASP.NET and web development workload.

3. Install the latest Blazor extension from the Visual Studio Marketplace.

4. Enable Visual Studio to use preview SDKs: Open Tools > Options in the menu bar. Open the Environment node. Open the Preview Features tab. Check the box for Use previews of the .NET Core SDK. Select OK.

5. 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.

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 framework offering a fully dynamic page compositing model, multi-site support, designer friendly templates ( skins ), and extensibility via third party modules.

At this point Oqtane offers a minimum of desired functionality and is not recommended for production usage. The expectation is that Oqtane will rapidly evolve as a community driven open source project. At this point in time we do not promise any upgrade path from one version to the next, and developers should expect breaking changes as the framework stabilizes.

Release Announcement

Announcing Oqtane... a Modular Application Framework for Blazor!

Example Screenshots

A simplistic login flow ( note that a full authentication story has not been implemented at this point ):

Login

Main view for authorized users, allowing full management of modules and content:

Admin View

Content editing user experience using modal dialog:

Edit Content

Context menu for managing specific module on page:

Manage Module

Control panel for adding, editing, and deleting pages as well as adding new modules to a page:

Manage Page