Skip to content

RUN_EXDA.md

Latest commit

 

History

History
85 lines (60 loc) · 2.92 KB

RUN_EXDA.md

File metadata and controls

85 lines (60 loc) · 2.92 KB

Run EXDA

EXDA is now documented as a browser-first app.

For day-to-day use, the recommended workflow is:

  • clone or download the repository
  • run the setup file for your operating system once
  • run the launcher for your operating system
  • let the launcher check requirements, start the backend, and open the browser

Setup Once

The setup scripts:

  • create or repair .venv
  • run npm install
  • install backend/requirements.txt
  • install backend/requirements-optional.txt
  • verify the resulting environment

Launchers

Terminal shortcuts from the repo root:

  • Linux/macOS: ./run exda
  • Windows Command Prompt: run exda
  • Windows PowerShell: .\run.cmd exda

What the launchers do

  • check for required tools: node, npm, and python
  • check that core npm packages are installed
  • check that packages from backend/requirements.txt are available
  • print a clear list of missing tools or packages
  • start the Flask backend on http://127.0.0.1:5000
  • start the Vite frontend and open the browser

First-time setup

If the launcher reports missing dependencies, run the appropriate setup steps once.

Linux and macOS

npm install
python3 -m venv .venv
source .venv/bin/activate
pip install -r backend/requirements.txt

Optional extras:

pip install -r backend/requirements-optional.txt

Windows

npm install
py -3 -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r backend\requirements.txt

Optional extras:

pip install -r backend\requirements-optional.txt

Notes

  • AiRA can remain limited if optional local AI tooling such as Ollama is not installed.
  • The launchers are intended for users running the app from a repository checkout.
  • Packaged desktop builds are still possible, but they are now treated as a secondary release workflow. See PACKAGING.md.