FEAT add skeleton backend for the GUI/frontend (microsoft#1298)

Author: romanlutz

.dockerignore

@@ -39,3 +39,6 @@ default_memory.json.memory
 frontend/node_modules/
 frontend/dist/
 frontend/.vite/
+
+# Backend frontend directory (generated during packaging)
+pyrit/backend/frontend/

.flake8

@@ -13,6 +13,8 @@ exclude =
     *lib/python*,
     *egg,
     build,
+    frontend/dev.py,
+    pyrit/backend/main.py,
     pyrit/cli/pyrit_shell.py,
     pyrit/prompt_converter/morse_converter.py,
     pyrit/prompt_converter/emoji_converter.py,

.gitignore

@@ -5,6 +5,9 @@ dbdata/
 eval/
 default_memory.json.memory
 
+# Frontend build artifacts copied to backend for packaging
+pyrit/backend/frontend/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

MANIFEST.in

@@ -8,3 +8,4 @@ recursive-include pyrit *.wav
 recursive-include pyrit *.mp4
 recursive-include pyrit *.md
 include pyrit/auxiliary_attacks/gcg/src/Dockerfile
+recursive-include pyrit/backend/frontend *

Makefile

@@ -1,6 +1,6 @@
 .PHONY: all pre-commit mypy test test-cov-html test-cov-xml
 
-CMD:=uv run --active -m
+CMD:=uv run -m
 PYMODULE:=pyrit
 TESTS:=tests
 UNIT_TESTS:=tests/unit
@@ -17,8 +17,8 @@ mypy:
 	$(CMD) mypy $(PYMODULE) $(UNIT_TESTS)
 
 docs-build:
-	uv run --active jb build -W -v ./doc
-	uv run --active ./build_scripts/generate_rss.py
+	uv run jb build -W -v ./doc
+	uv run ./build_scripts/generate_rss.py
 
 # Because of import time, "auto" seemed to actually go slower than just using 4 processes
 unit-test:

doc/contributing/1a_install_uv.md

@@ -51,6 +51,8 @@ However, there are many reasons to install as a contributor. Yes, of course, if
     git clone https://github.com/Azure/PyRIT
     ```
 
+4. **Node.js and npm**. Required for building the TypeScript/React frontend. Download [Node.js](https://nodejs.org/) (which includes npm). Version 18 or higher is recommended.
+
 ## Installation with uv
 
 This is a guide for how to install PyRIT using uv

doc/contributing/1c_install_conda.md

@@ -11,6 +11,8 @@ This is a list of the prerequisites needed to run this library.
     git clone https://github.com/Azure/PyRIT
     ```
 
+1. **Node.js and npm**. Required for building the TypeScript/React frontend. Download [Node.js](https://nodejs.org/) (which includes npm). Version 18 or higher is recommended.
+
 Note: PyRIT requires Python version 3.10, 3.11, 3.12, or 3.13. If using Conda, you'll set the environment to use this version. If running PyRIT outside of a python environment, make sure you have this version installed.
 
 ## Installation with conda

doc/index.md

@@ -11,7 +11,6 @@ potentially harmful outputs, which can take many forms, including harmful conten
 incitement or glorification of violence, or sexual content." Additionally, a variety of security risks
 can be introduced by the deployment of an AI system.
 
-(installation-guide)=
 ## Installation Guide
 
 PyRIT offers flexible installation options to suit different needs. Choose the path that best fits your use case:

frontend/README.md

@@ -2,47 +2,50 @@
 
 Modern TypeScript + React frontend for PyRIT, built with Fluent UI.
 
-## Quick Start
-
-### Installation
+## Development
 
 ```bash
+# Install dependencies
 npm install
-```
-
-### Running the Frontend
 
-```bash
-# Start the frontend server
+# Start both backend and frontend (cross-platform)
 python dev.py start
+# OR use npm script
+npm run start
 
-# Stop the frontend server
-python dev.py stop
-
-# Restart the frontend server
+# Restart both servers
 python dev.py restart
-```
+# OR
+npm run restart
 
-The frontend will be available at `http://localhost:3000`
-
-### Alternative: Using npm directly
+# Stop all servers
+python dev.py stop
+# OR
+npm run stop
 
-```bash
+# Run Vite dev server only (backend must be started separately)
 npm run dev
-```
 
-### Building for Production
-
-```bash
+# Build for production
 npm run build
+
+# Preview production build
+npm run preview
 ```
 
-The built files will be in the `dist/` directory.
+**Development Mode**: The `dev.py` script sets `PYRIT_DEV_MODE=true` so the backend expects the frontend to run separately on port 3000.
+
+**Production Mode**: When installed from PyPI, the backend serves the bundled frontend and will exit if frontend files are missing.
 
-## Tech Stack
+## Stack
 
 - **React 18** - UI framework
 - **TypeScript** - Type safety
 - **Fluent UI v9** - Microsoft design system
 - **Vite** - Fast build tool
+- **Axios** - HTTP client
+
+## Configuration
+
+The frontend proxies API requests to `http://localhost:8000` in development.
 Configure this in `vite.config.ts` if needed.