CEReS - Crisis Escalation and Response System​

Powered by IRIS (Incident Resolution Intelligence System)

Simple run instructions.

Requirements

• Node.js (LTS)
• Python 3
• Preferrably make sure no other process is running on http://localhost:3000 and http://localhost:4000

Env set up

• Backend (required for AI): backend/.env
  • AZURE_OPENAI_API_KEY=...
  • AZURE_OPENAI_API_VERSION=...
  • AZURE_OPENAI_ENDPOINT=...
• If these are not set up, the app will default to "dummy" data.

Local web browser hosting (Recommended)

From the root directory, run:

npm --prefix frontend run web

This should automatically open the web locally and is ready to run!

Desktop App

Run (Dev)

• cd frontend && npm install && npm run dev:desktop

Build (Desktop App)

• cd frontend && npm install && npm run dist

Local Web Browser hosting (Manual set up)

Run (Dev)

• Open two terminal tabs at the root directory

Tab 1

cd frontend
npm install
npm run dev

Tab 2

At root directory

pip install -r backend/requirements.txt
uvicorn backend.main:app --host localhost --port 4000

Run the app

Finally, go to the local host link given when you run npm run dev (eg: http://localhost:3000) and you can start using the app!

Email Integration Set Up (on App)

• After signing in, go to Email section
• Follow the steps to set up Email integration
• Troubleshooting: for app password, ensure that your gmail has 2FA set up
• Turn Auto poll - ON if you want automatic updates

Optional

• Frontend (optional): frontend/.env.local
  • NEXT_PUBLIC_BACKEND_URL=http://localhost:4000
• Desktop App (not web browser) flags (set at launch; do NOT put these in .env files)
  • ENABLE_BACKEND_AUTOSTART=true|false (default true)
  • ENABLE_BACKEND_AUTOINSTALL=true|false (default true)
  • PYTHON=/path/to/python3
  • Examples (set flags on the command you run):
    • macOS/Linux (dev):

      # Disable autostart
      ENABLE_BACKEND_AUTOSTART=false npm run dev:desktop
      # Custom backend URL
      NEXT_PUBLIC_BACKEND_URL=http://127.0.0.1:4010 npm run dev:desktop
      # Force Python path
      PYTHON=/usr/local/bin/python3 npm run dev:desktop
      # Combine flags
      NEXT_PUBLIC_BACKEND_URL=http://127.0.0.1:4010 ENABLE_BACKEND_AUTOSTART=false PYTHON=/usr/local/bin/python3 npm run dev:desktop

    • Windows PowerShell (dev):

      $env:ENABLE_BACKEND_AUTOSTART = "false"; npm run dev:desktop
      $env:NEXT_PUBLIC_BACKEND_URL = "http://127.0.0.1:4010"; npm run dev:desktop
      $env:PYTHON = "C:\\Python311\\python.exe"; npm run dev:desktop

    • Packaged app:
      • macOS:

        NEXT_PUBLIC_BACKEND_URL=http://127.0.0.1:4010 ./dist/mac/IRIS.app/Contents/MacOS/IRIS

      • Windows (PowerShell):

        $env:NEXT_PUBLIC_BACKEND_URL = "http://127.0.0.1:4010"; & "C:\\Path\\To\\IRIS.exe"

      • Linux:

        NEXT_PUBLIC_BACKEND_URL=http://127.0.0.1:4010 ./dist/IRIS-*.AppImage