Skip to content

Quick Start

Alexa Amundson edited this page Nov 17, 2025 · 1 revision

Quick Start

If you just want to see BlackRoad OS in action without a full setup, follow these minimal steps:

  1. Make sure Python 3.10+ is installed on your machine.
  2. Clone the repository and install dependencies:
    git clone https://github.com/blackboxprogramming/BlackRoad-Operating-System.git  
    cd BlackRoad-Operating-System  
    pip install -r requirements.txt  
  3. Start the backend API using Uvicorn:
    uvicorn backend.main:app --reload  
  4. Open the desktop interface by launching backend/static/index.html in your browser (or use the packaged executable if available).
  5. Log in with your credentials or create an account if sign‑up is enabled.

You should now have the BlackRoad OS desktop running locally and can explore its features.

Clone this wiki locally