174 lines
9.5 KiB
Markdown
174 lines
9.5 KiB
Markdown
# Latest Release
|
|
|
|
[5.2.1](https://github.com/oqtane/oqtane.framework/releases/tag/v5.2.1) was released on August 22, 2024 and is a maintenance release including 41 pull requests by 5 different contributors, pushing the total number of project commits all-time to over 5700. The Oqtane framework continues to evolve at a rapid pace to meet the needs of .NET developers.
|
|
|
|
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Foqtane%2Foqtane.framework%2Fmaster%2Fazuredeploy.json)
|
|
|
|
# Oqtane Framework
|
|
|
|
|
|
|
|
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](https://www.oqtane.org/blog/!/20/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](https://dotnetfoundation.org/code-of-conduct)**
|
|
|
|
# Getting Started (Version 5.x)
|
|
|
|
**Installing using source code from the Dev/Master branch:**
|
|
|
|
- Install **[.NET 8.0.8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)**.
|
|
|
|
- Install the latest edition (v17.9 or higher) of [Visual Studio 2022](https://visualstudio.microsoft.com/downloads) 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 (or download) the Oqtane Master or Dev branch source code to your local system.
|
|
|
|
- Open the **Oqtane.sln** solution file.
|
|
|
|
- **Important:** Rebuild the entire solution before running it (ie. Build / Rebuild Solution).
|
|
|
|
- Make sure you specify Oqtane.Server as the Startup Project.
|
|
|
|
- Run the application... an Installation Wizard screen will be displayed which will allow you to configure your preferred database and create a host user account.
|
|
|
|
**Developing a custom module:**
|
|
|
|
- follow the instructions for installing using source code outlined above
|
|
|
|
- login as the host user
|
|
|
|
- navigate to Control Panel (gear icon at top-right of page), Admin Dashboard, Module Management
|
|
|
|
- select Create Module
|
|
|
|
- enter information corresponding to the module you wish to create and then select the Create button
|
|
|
|
- make note of the Location where the code was generated and open the solution file in Visual Studio
|
|
|
|
- Build / Rebuild Solution, ensure the Oqtane.Server is set as the Startup Project, and hit F5 to run the solution
|
|
|
|
**Installing an official release:**
|
|
|
|
- all official releases of Oqtane are distributed on [GitHub](https://github.com/oqtane/oqtane.framework/releases). Releases include an Install.zip package for new installations and an Upgrade.zip for existing installations.
|
|
|
|
- A detailed set of instructions for installing Oqtane on Azure is located here: [Installing Oqtane on Azure](https://blazorhelpwebsite.com/ViewBlogPost/1)
|
|
|
|
- A detailed set of instructions for installing Oqtane on IIS is located here: [Installing Oqtane on IIS](https://www.oqtane.org/Resources/Blog/PostId/542/installing-oqtane-on-iis)
|
|
- Instructions for upgrading Oqtane are located here: [Upgrading Oqtane](https://www.oqtane.org/Resources/Blog/PostId/543/upgrading-oqtane)
|
|
|
|
**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](https://visualstudio.github.com/). 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](https://www.youtube.com/watch?v=JPfUZPlRRCE&list=PLYhXmd7yV0elLNLfQwZBUlM7ZSMYPTZ_f) 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](https://www.oqtane.net)
|
|
|
|
|
|
# Documentation
|
|
There is a separate [Documentation repository](https://github.com/oqtane/oqtane.docs) 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](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.2.1](https://github.com/oqtane/oqtane.framework/releases/tag/v5.2.1) (Aug 22, 2024)
|
|
- [x] Stabilization improvements
|
|
- [x] Unzip support in File Management
|
|
|
|
[5.2.0](https://github.com/oqtane/oqtane.framework/releases/tag/v5.2.0) (Jul 25, 2024)
|
|
- [x] Site Content Search
|
|
- [x] RichTextEditor extensibility
|
|
- [x] Scalability and performance improvements
|
|
|
|
[5.1.2](https://github.com/oqtane/oqtane.framework/releases/tag/v5.1.2) (May 28, 2024)
|
|
- [x] Stabilization improvements
|
|
|
|
[5.1.1](https://github.com/oqtane/oqtane.framework/releases/tag/v5.1.1) (Apr 16, 2024)
|
|
- [x] Stabilization improvements
|
|
|
|
[5.1.0](https://github.com/oqtane/oqtane.framework/releases/tag/v5.1.0) (Mar 27, 2024)
|
|
- [x] Migration to the new unified Blazor approach in .NET 8 (ie. blazor.web.js)
|
|
- [x] Static Server Rendering (SSR) support
|
|
|
|
[5.0.2](https://github.com/oqtane/oqtane.framework/releases/tag/v5.0.2) (Jan 25, 2024)
|
|
- [x] Stabilization improvements
|
|
|
|
[5.0.1](https://github.com/oqtane/oqtane.framework/releases/tag/v5.0.1) (Dec 21, 2023)
|
|
- [x] Stabilization improvements
|
|
|
|
[5.0.0](https://github.com/oqtane/oqtane.framework/releases/tag/v5.0.0) (Nov 16, 2023)
|
|
- [x] Migration to .NET 8
|
|
|
|
➡️ Full list and older versions can be found in the [docs roadmap](https://docs.oqtane.org/guides/roadmap/index.html)
|
|
|
|
# Background
|
|
Oqtane was created by [Shaun Walker](https://www.linkedin.com/in/shaunbrucewalker/) and is inspired by the DotNetNuke web application framework. 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!](https://builtonblazor.net) - a showcase of sites built on Blazor
|
|
|
|
[.NET Foundation Project Trends](https://www.dnfprojects.com) - 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.
|
|
|
|
|
|
|
|
# Databases
|
|
|
|
As of version 2.1 (June 2021) Oqtane supports multiple relational database providers - SQL Server, SQLite, MySQL, PostgreSQL
|
|
|
|
|
|
|
|
# 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 various administrative features of the framework:
|
|
|
|
|
|
|
|
Responsive design mobile view:
|
|
|
|
|