+2. install **ollama and pull models** granite4:micro, moondream:latest, gemma3:4b , gemma3:1b
+ see "startup\ollama_check.sh"
-For more information on Rescue Lab see our [web site](https://rescue-lab.org).
+3. **install and run pgvector docker container** on macos/Linux/windows
------------------------
-Notes for Developers Only:
+ "startup\docker-compose.yml"
+ "startup\pgvector_start.sh"
+ "startup\check_pgvector_db.sh"
+
+4. **download and extract onnx models** from :
+ https://umass-my.sharepoint.com/:u:/g/personal/jaikumar_umass_edu/IQAiVKIZKA8QT6EEVDLqmc5NAWuYAy8wl9I3K2Ken5G7lLc?e=w8DjIl
+
+ extract rb_3.1_onnx_models.zip to rescuebox 
-
-RescueBox Desktop (RBox) is a self-contained binary offering a UI interface to a library of ML models for various forensic applications. To use RescueBox Desktop, start up a model application in the background adhering to the [Fastapi](https://github.com/UMass-Rescue/RescueBox/blob/main/flaskml_migration_steps.md) interface. You can now run the model [server](https://github.com/UMass-Rescue/RescueBox/blob/main/run_server) and interact by specifying its inputs on the UI and analyzing outputs when ready. RBox handles the rest: running the jobs, and interfacing with different ML models. Since RBox is aimed toward forensic analysts, it is designed to operate on local, or drive-mounted storage.
-
-For a review of the project's goals, read [What is RescueBox Desktop?](./docs/what-is-rescuebox-desktop.md). For a view into how RBox-Desktop works, read the [architecture section](#architecture).
-
-# Getting Started
-
-## Step 1: Download the Latest Release
-
-Get the latest release of the binary for your operating system (Windows) from the [source](https://github.com/UMass-Rescue/RescueBox/tree/main/RescueBox-Desktop).
-
-## Step 2: Start a Fastapi Compliant Model
-
-Download and run the [Fastapi](https://github.com/UMass-Rescue/RescueBox/wiki/Onboarding) model server.
-
-Run the model application server, which should provide you with a URL to RBox.
-
-## Step 3: Using the App
-Launch the Rescuebox-Desktop icon or see below to launch in dev mode using npm start.
-
-You should now be able to see the model application in the app, and be able to run inference tasks on it!
-
-
-
-## Additional Instructions for Mac
-
-
-Might need these before `npm install`
-```
-### Upgrade node if your node version is less than 14. (check with `node -v`)
-brew install node@20
-echo 'export PATH="/usr/local/opt/node@20/bin:$PATH"' >> ~/.zshrc
-
-### Install python-setuptools since we're using python 3.12
-brew install python-setuptools
-### Or install it from https://pypi.org/project/setuptools/ into the python environment on your command line
-```
-
-9. Install UI dependencies
-```
-cd RescueBox-Desktop
-npm install
-```
-
-10. Run UI
-```
-npm start
-```
-
-You should see the UI show up after this. Connect to your server and go to the "Models" tab to run the models.
-```
-# Development
-
-RescueBox Desktop is built using [Electron](https://www.electronjs.org/), [React](https://reactjs.org/), TypeScript, TailwindCSS, and SQlite (with Sequelize).
-
-
-## Prerequisites
-
-- Node v18 (newer versions may work)
-
-## Install
-
-Clone the repo and install dependencies:
-
-```bash
-git clone https://github.com/UMass-Rescue/RescueBox.git
-cd RescueBox-Desktop
-npm install
-```
-
-**Having issues installing? See this [debugging guide](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/400)**
-
-## Starting Development
-
-Start the app in the `dev` environment:
-
-```bash
-npm start
-```
-
-## Packaging for Production
-
-To package apps for the local platform:
-
-```bash
-1 build the rescuebox.exe using the rescuebox.spec in RescueBox directory. ( see file for instructions)
-
-2 copy pre reqs to assets\rb_server :
-winfsp-2.0.23075.msi , docs , demo files to run models
-
-3 copy these cmds to rb.bat and run it as one batch file
-rmdir /s /q assets\rb_server\dist
-move ../dist assets\rb_server
-cmd /c npm cache clean --force
-cmd /c npm cache verify
-cmd /c npm install
-cmd /c npm run postinstall
-cmd /c npm run build
-cmd /c npm run rebuild
-cmd /c npm exec electron-builder -- --win
-```
-note : release\app\package.json contains the version number
-
-4 release\build\RescueBox-Desktop Setup 2.0.0.exe should get created
-
-
-## Docs
-
-See electron-react's [docs and guides here](https://electron-react-boilerplate.js.org/docs/installation)
-
-
diff --git a/RescueBox-Desktop/assets/assets.d.ts b/RescueBox-Desktop/assets/assets.d.ts
deleted file mode 100644
index 251085e9..00000000
--- a/RescueBox-Desktop/assets/assets.d.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-type Styles = Record{children}
;
-}
-
-export default ReactMarkdownMock;
diff --git a/RescueBox-Desktop/src/__mocks__/RehypeExternalLinksMock.ts b/RescueBox-Desktop/src/__mocks__/RehypeExternalLinksMock.ts
deleted file mode 100644
index 9edee86a..00000000
--- a/RescueBox-Desktop/src/__mocks__/RehypeExternalLinksMock.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-import { Root } from 'react-markdown/lib';
-import { Options } from 'rehype-external-links';
-
-export default function RehypeExternalLinks(
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- options: Readonly
-
- );
-}
-
-export default function App() {
- return (
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
- Error: {error.message}
;
- if (!logs) return
-
- );
-}
diff --git a/RescueBox-Desktop/src/renderer/components/FallbackError.tsx b/RescueBox-Desktop/src/renderer/components/FallbackError.tsx
deleted file mode 100644
index d4c77be3..00000000
--- a/RescueBox-Desktop/src/renderer/components/FallbackError.tsx
+++ /dev/null
@@ -1,106 +0,0 @@
-import { FallbackProps } from 'react-error-boundary';
-import { mutate } from 'swr';
-import { CheckCircledIcon, CopyIcon } from '@radix-ui/react-icons';
-import { useState } from 'react';
-import { Button } from './ui/button';
-import CancelIcon from './icons/CancelIcon';
-import {
- Tooltip,
- TooltipContent,
- TooltipProvider,
- TooltipTrigger,
-} from './ui/tooltip';
-
-function resetSWRCache() {
- return mutate(() => true, undefined);
-}
-
-function ErrorContentForError({ error }: { error: Error }) {
- return (
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Refresh
-Clear Logs
-Export to File
-Copy Logs
-
-
-
- Displaying the last {MAX_LOGS} logs...
-
-
- {isLoading &&
-
-
- );
-}
-
-function ErrorContentForAnyError({ error }: { error: any }) {
- return (
- Error:
-{error.message}
- Call Stack:
-{error.stack}
-
-
- );
-}
-
-function FallbackError({ error, resetErrorBoundary }: FallbackProps) {
- const handleErrorReset = async (): Promise
- {!error ? 'Error is undefined' : error.toString()}
-
-
-
- );
-}
-
-export default FallbackError;
diff --git a/RescueBox-Desktop/src/renderer/components/InputField.tsx b/RescueBox-Desktop/src/renderer/components/InputField.tsx
deleted file mode 100644
index eb754c80..00000000
--- a/RescueBox-Desktop/src/renderer/components/InputField.tsx
+++ /dev/null
@@ -1,96 +0,0 @@
-import { InputSchema } from 'src/shared/generated_models';
-import { match } from 'ts-pattern';
-import DirectoryField from './input_fields/DirectoryField';
-import FileField from './input_fields/FileField';
-import TextField from './input_fields/TextField';
-import TextAreaField from './input_fields/TextAreaField';
-import BatchTextField from './input_fields/BatchTextField';
-import BatchDirectoryField from './input_fields/BatchDirectoryField';
-import BatchFileField from './input_fields/BatchFileField';
-import NewFileField from './input_fields/NewFileField';
-
-type InputFieldProps = {
- inputSchema: InputSchema;
- value: any;
- onChange: (value: any) => void;
- // eslint-disable-next-line react/require-default-props
- disabled?: boolean;
-};
-
-export default function InputField({
- inputSchema,
- value,
- onChange,
- disabled = false,
-}: InputFieldProps) {
- return (
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Copy Logs
-
- The application encountered a crash. Please copy the logs and share them
- with the developers.
-
- {error instanceof Error ? (
-
-
- );
-}
diff --git a/RescueBox-Desktop/src/renderer/components/LoadingScreen.tsx b/RescueBox-Desktop/src/renderer/components/LoadingScreen.tsx
deleted file mode 100644
index 8485d99d..00000000
--- a/RescueBox-Desktop/src/renderer/components/LoadingScreen.tsx
+++ /dev/null
@@ -1,16 +0,0 @@
-import { cn } from 'src/renderer/lib/utils';
-import LoadingIcon from './icons/LoadingIcon';
-
-// eslint-disable-next-line react/require-default-props
-function LoadingScreen({ className = '' }: { className?: string }) {
- return (
- - {inputSchema.label} -
- {inputSchema.subtitle && ( -{inputSchema.subtitle}
- )} - {match(inputSchema) - .with({ inputType: 'text' }, () => ( -Unsupported input type.
- ))}
-
-
- );
-}
-
-export default LoadingScreen;
diff --git a/RescueBox-Desktop/src/renderer/components/ParameterField.tsx b/RescueBox-Desktop/src/renderer/components/ParameterField.tsx
deleted file mode 100644
index 73c36119..00000000
--- a/RescueBox-Desktop/src/renderer/components/ParameterField.tsx
+++ /dev/null
@@ -1,99 +0,0 @@
-import { ParameterSchema } from 'src/shared/generated_models';
-import { match } from 'ts-pattern';
-import TextField from './parameter_fields/TextField';
-import IntField from './parameter_fields/IntField';
-import FloatField from './parameter_fields/FloatField';
-import EnumField from './parameter_fields/EnumField';
-import RangedIntField from './parameter_fields/RangedIntField';
-import RangedFloatField from './parameter_fields/RangedFloatField';
-
-export default function ParameterField({
- parameterSchema,
- value,
- onChange,
- disabled = false,
-}: {
- parameterSchema: ParameterSchema;
- value: any;
- onChange: (value: any) => void;
- // eslint-disable-next-line
- disabled?: boolean;
-}) {
- const { value: paramValue } = parameterSchema;
- return (
-
-
- Loading...
-
-
- );
-}
diff --git a/RescueBox-Desktop/src/renderer/components/PreviewFileResponse.tsx b/RescueBox-Desktop/src/renderer/components/PreviewFileResponse.tsx
deleted file mode 100644
index 56ba2594..00000000
--- a/RescueBox-Desktop/src/renderer/components/PreviewFileResponse.tsx
+++ /dev/null
@@ -1,76 +0,0 @@
-import { FileResponse } from 'src/shared/generated_models';
-import { Cross1Icon, OpenInNewWindowIcon } from '@radix-ui/react-icons';
-import { Button } from './ui/button';
-import {
- Dialog,
- DialogContent,
- DialogDescription,
- DialogHeader,
- DialogTitle,
-} from './ui/dialog';
-import FilePreview from './response_body/previews/FilePreview';
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export default function PreviewFileResponse({
- response,
- open,
- setOpen,
-}: {
- response: FileResponse;
- open: boolean;
- setOpen: (open: boolean) => void;
-}) {
- return (
- - {parameterSchema.label} -
- {parameterSchema.subtitle && ( -{parameterSchema.subtitle}
- )} - {match(paramValue) - .with({ parameterType: 'text' }, () => { - return ( -Unsupported parameter type: {paramValue.parameterType}
- );
- })}
-
-
-
- );
-}
diff --git a/RescueBox-Desktop/src/renderer/components/custom_ui/RegisterModelButton.tsx b/RescueBox-Desktop/src/renderer/components/custom_ui/RegisterModelButton.tsx
deleted file mode 100644
index 22358bfc..00000000
--- a/RescueBox-Desktop/src/renderer/components/custom_ui/RegisterModelButton.tsx
+++ /dev/null
@@ -1,28 +0,0 @@
-import { Link } from 'react-router-dom';
-import { Button } from '../ui/button';
-import { ConnectIcon } from '../icons/ConnectIcon';
-
-export default function RegisterModelButton({
- replace = false,
-}: {
- replace: boolean;
-}) {
- return (
-
-
-
- );
-}
diff --git a/RescueBox-Desktop/src/renderer/components/custom_ui/customButtons.tsx b/RescueBox-Desktop/src/renderer/components/custom_ui/customButtons.tsx
deleted file mode 100644
index a4b8edd2..00000000
--- a/RescueBox-Desktop/src/renderer/components/custom_ui/customButtons.tsx
+++ /dev/null
@@ -1,78 +0,0 @@
-import { Button } from '@shadcn/button';
-import {
- Tooltip,
- TooltipContent,
- TooltipProvider,
- TooltipTrigger,
-} from '@shadcn/tooltip';
-import { Link } from 'react-router-dom';
-import { Job, MLModel } from 'src/shared/models';
-import CancelIcon from '../icons/CancelIcon';
-import DeleteIcon from '../icons/DeleteIcon';
-
-export function ViewButton({ job }: { job: Job }) {
- return (
-
-
-
- );
-}
-
-export function JobRedButton({
- job,
- variant,
- handleClick,
-}: {
- job: Job;
- variant: 'cancel' | 'delete';
- handleClick: (job: Job) => void;
-}) {
- return (
- {variant === 'cancel' ? 'Cancel' : 'Delete'}
-Delete
-
-
-
-
- );
-}
diff --git a/RescueBox-Desktop/src/renderer/components/input_fields/BatchFileField.tsx b/RescueBox-Desktop/src/renderer/components/input_fields/BatchFileField.tsx
deleted file mode 100644
index 432506fd..00000000
--- a/RescueBox-Desktop/src/renderer/components/input_fields/BatchFileField.tsx
+++ /dev/null
@@ -1,39 +0,0 @@
-import { Button } from '../ui/button';
-import { Input } from '../ui/input';
-
-export default function BatchFileField({
- onChange,
- value,
- disabled = false,
-}: {
- onChange: (paths: string[]) => void;
- value: string;
- disabled: boolean;
-}) {
- const handleSelectFiles = async () => {
- await window.fileSystem.selectFiles().then((paths) => {
- onChange(paths);
- return paths;
- });
- };
-
- const handleOpenFile = async () => {
- await window.fileSystem.openPath({ path: value });
- };
- return (
-
-
-
-
- );
-}
diff --git a/RescueBox-Desktop/src/renderer/components/input_fields/BatchTextField.tsx b/RescueBox-Desktop/src/renderer/components/input_fields/BatchTextField.tsx
deleted file mode 100644
index 792dcaa4..00000000
--- a/RescueBox-Desktop/src/renderer/components/input_fields/BatchTextField.tsx
+++ /dev/null
@@ -1,119 +0,0 @@
-import { useState } from 'react';
-import { MinusCircledIcon, PlusCircledIcon } from '@radix-ui/react-icons';
-import { Button } from '../ui/button';
-import { Textarea } from '../ui/textarea';
-import {
- Tooltip,
- TooltipContent,
- TooltipProvider,
- TooltipTrigger,
-} from '../ui/tooltip';
-
-export default function BatchTextField({
- value,
- onChange,
- disabled = false,
-}: {
- value: string[];
- onChange: (value: string[]) => void;
- disabled: boolean;
-}) {
- const [fields, setFields] = useState
- {!disabled && fields.length === 0 && (
-
-