User Manual

Deployment Manual

Clone the repository

Open a terminal and run:

    git clone https://github.com/snaker938/vscode-blueprint-ai
    cd vscode-blueprint-ai

Install Node.js dependencies

Install all necessary dependencies for the extension:

    npm run install:all

Set up the Python OCR environment

Inside the /python-ocr folder, you have a requirements.txt file, a venv folder, and your project files. Follow these steps to set up the Python dependencies:

1. Change directory:

    cd python-ocr

2. Create venv file:

    python -m venv venv

3. Activate the virtual environment:

On Windows:

    .\venv\Scripts\Activate.ps1

On macOS/Linux:

    source venv/bin/activate

4. Install Python dependencies:

    pip install -r requirements.txt

5. Build the extension

Compile and prepare the webview:

    npm run build:all

6. Launch the Frontend UI

You can launch the frontend UI using one of the following methods:

Method 1: Via Terminal

Change directory into the webview-ui folder and run the development server:

    cd webview-ui
    npm run dev

Method 2: Via Visual Studio Code Debugging

Open the project in Visual Studio Code, press the F5 key (or function F5), and then click on the npm: build:all option to launch the extension in debugging mode.

You will need to insert your own OpenAI API key, so make sure you have those ready!

Legal issues and processes

GDPR Compliance Statement
In compliance with the General Data Protection Regulation (GDPR) and applicable data protection laws, the Blueprint AI UI v1.0 extension explicitly declares that it does not independently store or process any personal data related to end users. All design interactions, preferences, and project states are maintained exclusively as anonymised JSON node trees stored locally on the user's device, thus safeguarding individual privacy. It is important to acknowledge, however, that third-party ReactJS libraries (such as CraftJS, FluentUI, and React Grid Layout), integrated into this extension might incidentally process transient user information. Any such incidental processing adheres strictly to GDPR principles and does not involve permanent storage or handling by Blueprint AI UI v1.0.

Privacy Statement
Blueprint AI UI v1.0 maintains rigorous standards of transparency and accountability, ensuring users retain full visibility over how their design data is managed. All generated content, including AI-assisted layouts via GPT-4 and DALL-E 3, is performed without retaining personally identifiable user data, aligning with GDPR and the Data Protection Act 2018. Users have the right to inquire into the handling of data by integrated third-party libraries, and our documentation transparently details the minimal scope of data interactions. Thus, our system is fully GDPR-compliant, designed to foster trust and confidence among users through stringent adherence to lawful data processing practices and clear delineation of data-handling responsibilities. For more details, please refer to the MIT Privacy Statement.