Skip to content

RescueBox Build

jai kumar edited this page Aug 4, 2025 · 1 revision

RescueBox build overview

RescueBox is a set of tools for law enforcement to assist with investigations.

RescueBox backend is a set of plugins that implement a cli and a rest api to interface.

RescueBox-Desktop is the frontend electon app UI to interact with the plugins running in the backend.

Autoui is a developer only frontend for quick execution to assist in testing plugins.

Build steps

See the RescueBox README_EXE for instructions on how to build the backend fastapi server (#1) and the frontend rescuebox-desktop(#2).

rescuebox backend is a pyinstaller spec to build the backend server. readme

rescuebox frontend gives and overview of the frontend and how to run in a developer/test environment

## Instead of building, to run the backend server for developement purpose 
./run_server , this will run the python server assuming this repo is checked out and pre-reqs installed.

Then visit http://localhost:8000/ to interact with the Rest-Interface.

Building the static assets for developer UI ( autoui ) .

this UI is different than the production electron based app in RescueBox-Desktop, use it for quick development work to test

AutoUI uses Vite to build the static assets. To build the assets, run:

# /web/rescuebox-autoui
npm run build

or

# /web/rescuebox-autoui
npm run build:watch

The built assets will be in src/rb-api/rb/api/static/index. They are then served by the API static file server.