Getting Started

Getting Started

This guide provides steps to set up and run BlackRoad OS locally.

Prerequisites

• Python 3.10+ installed on your system.
• Node.js and npm for building any frontend assets.
• Git for cloning the repository.

Installation

1. Clone the repository using git:
   git clone https://github.com/blackboxprogramming/BlackRoad-Operating-System.git
2. Navigate to the project directory:
   cd BlackRoad-Operating-System
3. Install Python dependencies:
   pip install -r requirements.txt
4. Copy or create a .env file and set required environment variables (API keys, database URLs, etc.).

Running the Backend

• Start the FastAPI server using Uvicorn:
  uvicorn backend.main:app --reload
• The API will be available at http://localhost:8000.

Running the Desktop UI

• Open the index.html file in your browser or run the frontend dev server if available.
• The desktop UI connects to the backend API running locally.

Refer to the INTEGRATION_GUIDE.md in the docs folder for details on configuring third‑party services.