Table of Contents

Install Oqtane for Visual Studio Development

Development Version (Latest)

For general development and keeping up with the latest features, you can use the development branch of Oqtane Framework. However, for module development, it is recommended to target a stable release version of Oqtane Framework.

  1. Install Latest .NET SDK Release.

  2. Install the latest edition of Visual Studio with the ASP.NET and web development workload enabled. Oqtane works with ALL editions of Visual Studio from Community to Enterprise.

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

  4. Visit the Oqtane Framework GitHub Repository to download and extract the Oqtane Dev Branch Source Zip File or clone the Oqtane dev branch source code to your local system using Git Bash with the following command:

    git clone -b dev https://github.com/oqtane/oqtane.framework.git
    
  5. Open the Oqtane.sln solution file.

  6. Build the solution.

  7. Ensure that you specify Oqtane.Server as the Startup Project.

  8. Run the application.

Release and Legacy Development

Below is a list of current and prior releases for module development targeting different frameworks. Check the official release page for any newer versions not listed.

Oqtane Version 5 (.net 8)

  1. Install .NET 8 SDK

  2. Install the latest edition 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.

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

  4. Download the Official Oqtane 5 Release Source.

  5. Open the Oqtane.sln solution file.

  6. Build the solution.

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

  8. Run the application.

Oqtane Version 4 (.net 7)

  1. Install .NET 7 SDK

  2. Install the latest edition 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.

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

  4. Download the Official Oqtane Release Source 4.0.6.

  5. Open the Oqtane.sln solution file.

  6. Build the solution.

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

  8. Run the application.

Oqtane Version 3 (.net 6)

  1. Install .NET 6 SDK

  2. Install the latest edition 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.

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

  4. Download the latest Official Oqtane Release Source 3.4.3.

  5. Open the Oqtane.sln solution file.

  6. Build the solution.

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

  8. Run the application.

Oqtane Version 2 (.net 5)

  1. Install the latest .NET 5 SDK (v5.0.100)

  2. Install the latest edition (v16.8 or higher) of Visual Studio 2019 (Community, Professional, or Enterprise Editions) with the ASP.NET and web development workload enabled. Oqtane works with ALL editions of Visual Studio from Community to Enterprise.

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

  4. Download the Official Oqtane Release Source 2.3.1.

  5. Open the Oqtane.sln solution file.

  6. Build the solution.

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

  8. Run the application.

Oqtane Version 1 (.net core 3)

  1. Install .NET Core 3.1 SDK (v3.1)

  2. Install Visual Studio 2019 (Community, Professional, or Enterprise Editions) with the ASP.NET and web development workload enabled. Oqtane works with ALL editions of Visual Studio from Community to Enterprise.

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

  4. Download the Official Oqtane Release Source 1.0.4.

  5. Open the Oqtane.sln solution file.

  6. Build the solution.

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

  8. Run the application.


Resources

← Back to Installation Home