Skip to main content

Run the API

Development mode​

npm run dev

Development mode uses nodemon so changes restart the server.

Production mode​

npm start

By default the server listens on http://localhost:3333.

Debug mode​

npm run start:debug

The Node.js inspector listens on port 9229.

Docker Compose​

docker compose up --build

The Docker image includes the local test fixture at /app/test/resources/deepphe.sqlite3. Set DB_PATH in .env before starting the container.

Verify the server​

Open the live API documentation:

http://localhost:3333/docs

Or fetch the OpenAPI JSON:

http://localhost:3333/openapi.json