In a new uv environment:

uv pip install git+https://github.com/facebookresearch/openapps.git

Manual Installation

  • Pre-requisite: install uv (a much faster pip): pip install uv (or from source)

0) Clone repo

1) Install packages: uv sync

2) Activate environment: source .venv/bin/activate

3) Install playwright install chromium

Optionally install for onlineshop (off by default)

Onlineshop java + spacy configuration

4) Prepare Java, Webshop data and spacy model: chmod +x setup.sh and ./setup.sh for Linux X64 or Mac ARM64 systems

5) Designate Java path: source setup_javapath.sh for Linux X64 or Mac ARM64 systems

6) Check java -version gives you java version "21.0.1"

7) Build search engine indexes: chmod +x setup_pyserini.sh and ./setup_pyserini.sh

Congratulations! The onlineshop is ready to be used. Remember in future, always run source setup_javapath.sh to configure Java path before launching onlineshop-related tasks.

Finally, launch with

uv run launch.py apps.onlineshop.enable=True