Skip to main content

Installation

Prerequisites​

  • Node.js 24 or newer
  • npm
  • A DeepPhe SQLite database

The API uses built-in Node.js SQLite support plus pure JavaScript and WASM dependencies, so it does not require a native build toolchain.

Install dependencies​

git clone https://github.com/DeepPhe/dphe-data-api.git
cd dphe-data-api
npm install

Configure environment​

Copy the example environment file and edit it for your database:

cp .env.example .env

Typical local values:

PORT=3333
DB_PATH=./test/resources/deepphe.sqlite3
TEST_PATIENT_ID=fake_patient1

DB_PATH can point to an absolute path or a path relative to the current working directory.