Table of Contents

Install Oqtane for Development using Visual Studio Code on Linux (VS Code Linux Ubuntu)

This document provides general instructions for installing Oqtane for development using Visual Studio Code on Linux Ubuntu. Oqtane is an open-source, modular application framework for Blazor that allows you to easily deploy and manage web applications on Azure or any web server.

TODO: Review and update all steps to ensure things are as clear, easy and not missing steps, and also adding images. This page will become more uniform with the others as this evolves.

Prerequisites

Before you start, make sure you have the following prerequisites:

  • A Linux Ubuntu machine with internet access and administrator privileges.
  • .NET SDK installed on your machine.
  • A database server installed on your machine or accessible from your network. You can use MySQL, PostgreSQL, SQLite, or SQL Server.

Steps

  1. Install Visual Studio Code:
    Install Visual Studio Code on your machine. You can either download the .deb package from the Visual Studio Code website and install it using the command sudo dpkg -i code*.deb, or use the snap package manager and run the command sudo snap install --classic code.

  2. Clone the Oqtane GitHub Repository:
    Clone the Oqtane GitHub repository to your local machine using the following command:

    git clone https://github.com/oqtane/oqtane.framework.git

  3. Open the Oqtane Folder in Visual Studio Code: Open the Oqtane folder in Visual Studio Code using the command:

    code oqtane.framework

  4. Install Required Extensions: Install the required extensions for Blazor development, such as C#, Razor+, and Blazor Snippets, from the Extensions tab on the left sidebar of Visual Studio Code.

  5. Build the Oqtane Solution: Build the Oqtane solution using the integrated terminal in Visual Studio Code. Navigate to the src folder and run the command:

    dotnet build

  6. Publish the Oqtane Project: Publish the Oqtane project to a folder by running the command:

    dotnet publish -c Release -o publish

Note: This may not copy everything over, please review contents of all the latest dll files are copied properly.

  1. Copy Folder Contents to Apache Folder: Copy the folder contents to the Apache folder that hosts the site using the command:

    sudo cp -r publish /var/www/html/oqtane

    You may need to change the destination folder according to your Apache configuration.

  2. Configure Apache:
    Configure Apache to serve the Oqtane application following the instructions from the Oqtane installation documentation on how to install Oqtane with Apache and MySQL or PostgreSQL.

  3. Access Your Oqtane Application:
    Access your Oqtane application by visiting the URL of your virtual host. For example, if your virtual host is oqtane.example.com, then your URL would be http://oqtane.example.com/.

  4. Follow the Installation Wizard:
    Follow the installation wizard to set up your Oqtane application. You will need to enter the administrator email and password, and optionally the site name and logo.

Congratulations!
You have successfully installed Oqtane for development using Visual Studio Code on Linux Ubuntu. Enjoy! 😊

Resources

← Back to Installation Home

Edit this page