Prompt Injection Protection
COMP0016 · 2025–26 · Team 28 · Client: Avanade
Systems Engineering · IXN

Deployment Manual

Technical guide for setting up, configuring, and deploying the Prompt Injection Protection platform in local and production environments.

The deployment manual documents installation, environment configuration, runtime dependencies, and troubleshooting for local and production-like setups.

System Requirements

  • Node.js: Version 18 or higher, with npm or pnpm [1]
  • Python: Version 3.10 or higher [2]
  • Database: SQLite (included, no separate installation needed)

Quick Start — Local Development

Follow these steps to run the platform locally:

First clone the repository and navigate to the project directory.
git clone https://github.com/DavidThomas01/comp0016_avanade_prompt_injection.git
cd comp0016_avanade_prompt_injection

Backend Setup

  • Navigate to the backend/ directory in the repository.
  • (Only necessary for first-time setup) Create a Python virtual environment: python -m venv .venv
  • Activate the virtual environment (Windows: .venv\Scripts\activate; Linux/macOS: source .venv/bin/activate)
  • Install dependencies: pip install -e ".[dev]"
  • Copy environment template: cp .env.example .env
  • Edit .env to add API keys and endpoints for LLM providers (OpenAI, Anthropic, etc.)
  • Start the backend: PYTHONPATH=src uvicorn main:app --reload --port 8080
  • Access Swagger documentation: http://localhost:8080/docs

Frontend Setup

  • In a separate terminal, navigate to the frontend/ directory.
  • Install dependencies: npm install
  • Start development server: npm run dev
  • Access the application: http://localhost:5173

Environment Configuration

Configure LLM model access by setting API keys and endpoints for each provider in the backend/.env file:

  • See .env.example for a complete list of available models.

Testing

  • Run unit tests from the backend directory: pytest
  • Run integration tests (requires real LLM API keys): pytest -m integration

Full Repository & Documentation

Complete Deployment Guide

For detailed troubleshooting, architecture diagrams, and advanced configuration options, refer to the main GitHub repository:

Open GitHub Repository →

Recommended: Review the README files in both frontend/ and backend/ directories for framework-specific setup instructions and contribution guidelines.

References

Official download pages for the runtime versions referenced above, in IEEE style.

  1. OpenJS Foundation, “Download Node.js,” nodejs.org. Accessed: Mar. 21, 2026. [Online]. Available: https://nodejs.org/en/download/
  2. Python Software Foundation, “Python downloads,” python.org. Accessed: Mar. 25, 2026. [Online]. Available: https://www.python.org/downloads/