Table of Contents

Oqtane Development Guides (WIP)

Oqtane is a .net 9.0 Blazor application that is designed to be modular and extensible. This means that you can create your own modules, themes, and other extensions to customize your Oqtane solution.

You are here because you want to develop on Oqtane or improve Oqtane itself.

Main Topics

  1. Extensions in General
    Themes, Modules, Language Packs, and other extensions.

  2. Extension Best Practices
    How to write good code and make your life easier.

  3. Themes (TODO: @thabaum :)

  4. Modules (TODO: @thabaum :)

  5. Build and Improve Oqtane (TODO: @thabaum :)

Prerequisites

To develop on Oqtane, you will typically need the following skills / tools:

  1. Visual Studio 2022 with the latest .net 8.0 SDK
  2. SQL Server (alternatives are possible, but this is the easiest to get started)
  3. C# programming skills

The following skills are also useful, or will need to be developed as you go:

  1. Blazor programming skills
  2. HTML / CSS / JavaScript / Bootstrap5 skills
  3. Git / GitHub skills
  4. Oqtane installation

Basic Setup

You will need to install Oqtane on your development machine to get started. For this you have 2 options:

  1. Clone/Fork the Oqtane Source Code to your local machine and run using Visual Studio
    This is the most common option, and the best way to also track down any issues.
  2. Install a runtime version of Oqtane in your web server
    This is the method you'll use when you create many Oqtane solutions, since it will run faster and allow you to focus on only the code you write.

Next Steps

Read about:

  1. Best Practices
  2. Themes
  3. Modules

Additional Resources