Skip to content
VectorHub Docs

Installation

The repository contains more than one VectorHub-related project. The public portal is in apps/portal. The main backend is in repos/VectorHub-dev/backend1/Client.

Portal

Section titled “Portal”

Requirements:

  • Node.js and npm

Commands:

Terminal window
cd apps/portal
npm install
npm run dev

The portal is an Astro app with React components. Documentation is served by Starlight in the same app.

Backend

Section titled “Backend”

Requirements:

  • Python 3.11+
  • Docker and Docker Compose

Commands from repos/VectorHub-dev:

Terminal window
docker compose -f backend1/Client/docker-compose.yml up edgedb qdrant
cd backend1/Client
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python server_endpoints.py

The backend listens on port 8081 by default.

Environment

Section titled “Environment”

Confirmed environment variables include:

  • PORT
  • TYPE_ENV
  • FRONTEND_APP_ORIGIN
  • SECRET_KEY_ADMIN
  • JWT_ACCESS_SECRET
  • JWT_REFRESH_SECRET
  • JWT_WS_SECRET
  • QDRANT_HOST
  • QDRANT_PORT
  • EDGEDB_HOST
  • EDGEDB_PORT
  • EDGEDB_USER
  • EDGEDB_PASSWORD
  • EMBEDDING_ENDPOINT

Do not commit real secrets. The repository includes example/test files, but production values must be supplied by the deployment environment.