Skip to content

Installation

Tiwut edited this page May 10, 2026 · 2 revisions

OS-Studio can be run either as a web application (accessible via your browser) or as a native desktop application using the Qt6 launcher.

Web / Node.js Version

Prerequisites

  • Node.js: v18 or higher.
  • Build tools: make, python3 (required for some Node native extensions and PTY support).
  • OS Dev Tools (Optional but recommended): nasm, gcc, qemu-system-x86_64, etc. (OS-Studio's Dependency Manager can help install these later).

Setup

  1. Clone the repository:

    git clone https://github.com/tiwut/OS-Studio.git
    cd OS-Studio
  2. Install dependencies:

    npm install
  3. Build the application:

    npm run build
  4. Start the server:

    npm run start

    (For active development, run npm run dev instead to enable hot module reloading).

  5. Open your browser and navigate to http://localhost:3000.


Native Launcher

The Native Launcher provides a more integrated desktop experience without needing to open a separate browser.

Prerequisites

  • C++ Compiler: GCC, Clang, or MSVC.
  • CMake: Version 3.16+ recommended.
  • Qt6: Ensure you have the WebEngineWidgets component installed.
  • Ensure you have already run npm install and npm run build in the main OS-Studio directory.

Build Instructions

  1. Navigate to the native_launcher directory:

    cd native_launcher
  2. Create a build directory and configure with CMake:

    mkdir build && cd build
    cmake ..
  3. Compile the launcher:

    make
  4. Run the application:

    ./OS_Studio_Launcher

    The launcher will automatically start the background Node.js server and open the UI in a native QtWebEngine window.

Clone this wiki locally