WebInterfaces

Not In Use

RescueBox is not strict about how web interfaces are built. It is only strict about how the API is implemented. This document is meant to provide some guidance on how to build web interfaces for RescueBox. The recommended approach is to use RescueBox API to serve static assets when running locally. However this is not the only approach and other approaches can be used to interact with the API.

AutoUI

AutoUI is a tool to automatically generate a UI for a CLI application and be served through the Rescuebox API. The intent is to have a generative UI for any CLI application. It is NOT meant to be the perfect UI for every CLI application.

Running locally

See the RescueBox API README for instructions on how to run the API locally.

# /
./run_server

Then visit http://localhost:8000/ to see the UI.

Building the static assets

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.

You can now develop in web/rescuebox-autoui as if it is a React application.