Skip to content

codephusiongene/oqtane.framework

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Latest Release

5.1.2 was released on May 28, 2024 and is primarily a stabilization release. This release includes 68 pull requests by 9 different contributors, pushing the total number of project commits all-time to over 5300. The Oqtane framework continues to evolve at a rapid pace to meet the needs of .NET developers.

Deploy to Azure

Oqtane Framework

Oqtane

Oqtane is an open source CMS and Application Framework that provides advanced functionality for developing web, mobile, and desktop applications on .NET. It leverages Blazor to compose a fully dynamic digital experience which can be hosted on Static Blazor, Blazor Server, Blazor WebAssembly, or Blazor Hybrid (via .NET MAUI).

Oqtane is being developed based on some fundamental principles which are outlined in the Oqtane Philosophy.

Please note that this project is owned by the .NET Foundation and is governed by the .NET Foundation Contributor Covenant Code of Conduct

Getting Started

Using Version 5:

  • Install .NET 8.0.5 SDK.

  • Install the latest edition (v17.9 or higher) of Visual Studio 2022 with the ASP.NET and web development workload enabled. Oqtane works with ALL editions of Visual Studio from Community to Enterprise. If you wish to use LocalDB for development ( not a requirement as Oqtane supports SQLite, mySQL, and PostgreSQL ) you must also install the Data storage and processing.

  • Clone the Oqtane dev branch source code to your local system.

  • Open the Oqtane.sln solution file.

  • Important: Rebuild the entire solution before running it.

  • Make sure you specify Oqtane.Server as the Startup Project

  • Run the application.

Installing an official release:

Additional Instructions

  • If you have already installed a previous version of Oqtane and you wish to do a clean database install, simply reset the DefaultConnection value in the Oqtane.Server\appsettings.json file to "". This will trigger a re-install when you run the application which will execute the database installation.

  • 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"

Video Series

  • If you are getting started with Oqtane, a series of videos are available which explain how to install the product, interact with the user interface, and develop custom modules.

Oqtane Marketplace

Explore and enhance your Oqtane experience by visiting the Oqtane Marketplace. Discover a variety of modules, themes, and extensions contributed by the community. Visit Oqtane Marketplace

Documentation

There is a separate Documentation repository which contains a variety of types of documentation for Oqtane, including API documentation that is auto generated using Docfx. The contents of the repository is published to Githib Pages and is available at https://docs.oqtane.org

Roadmap

This project is open source, and therefore is a work in progress...

Backlog (TBD)

  • Azure Autoscale support (ie. web farm)
  • Folder Providers
  • Generative AI Integration

5.1.2 (May 28, 2024)

  • Stabilization improvements

5.1.1 (Apr 16, 2024)

  • Stabilization improvements

5.1.0 (Mar 27, 2024)

  • Migration to the new unified Blazor approach in .NET 8 (ie. blazor.web.js)
  • Static Server Rendering (SSR) support

5.0.2 (Jan 25, 2024)

  • Stabilization improvements

5.0.1 (Dec 21, 2023)

  • Stabilization improvements

5.0.0 (Nov 16, 2023)

  • Migration to .NET 8

➡️ Full list and older versions can be found in the docs roadmap

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 and a Single Page Application (SPA) architecture. It is a modular application framework offering a fully dynamic page compositing model, multi-site support, designer friendly themes, and extensibility via third party modules.

Reference Implementations

Built On Blazor! - a showcase of sites built on Blazor

.NET Foundation Project Trends - tracks the most active .NET Foundation open source projects based on GitHub activity

Architecture

The following diagram visualizes the client and server components in the Oqtane architecture.

Architecture

Databases

As of version 2.1, Oqtane supports multiple relational database providers.

Databases

Example Screenshots

Install Wizard:

Installer

Default view after installation:

Home

A seamless login flow utilizing .NET Core Identity services:

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

Admin dashboard for accessing the various administrative features of the framework:

Admin Dashboard

Responsive design mobile view:

Mobile View

About

CMS & Application Framework for Blazor & .NET MAUI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 58.2%
  • HTML 34.7%
  • CSS 5.5%
  • JavaScript 1.5%
  • Other 0.1%