Skip to content

Manual Setup

optui edited this page May 25, 2025 · 15 revisions

Prerequisites

  • Python 3.10+
  • Node.js v22.15.0 or newer
  • Angular v19 or newer
  • cmake v3.23 or newer
  • CUDA Toolkit 11.7 or newer

Backend Setup

  1. Clone the repository

    git clone https://github.com/optui/ProjeCT.git
    cd ProjeCT
  2. Copy environment template

    cp backend/.env.example backend/.env
  3. Create and activate a virtual environment

    cd backend
    python3 -m venv .venv
    source .venv/bin/activate    # Windows: .venv\Scripts\activate
    pip install -e .
  4. Install LEAP

    ProjeCT relies on LLNL's LEAP library. Check the LEAP installation guide.

    git clone https://github.com/LLNL/LEAP.git
    cd LEAP
    mv setup.py setup_torch.py
    mv setup_ctype.py setup.py
    pip install .
  5. Run the backend

    chmod +x scripts/run.sh
    scripts/run.sh

    ⚠️ On first run, GATE 10 datasets (~11 GB) download automatically.

  6. View API documentation

Frontend Setup

  1. Install dependencies

    cd frontend
    npm install
  2. Run or build the frontend

Summary

  • Backend Development: Run scripts/run.sh to start the FastAPI server with auto-reload
  • Frontend Development: Use ng serve for hot-reload development
  • Production Testing: Build frontend with npm run build:prod and test via backend server
  • API Testing: Use Swagger UI at /docs for interactive API testing
Clone this wiki locally