How to install Base Ping

Overview

Base Ping is a core part of the Base Platform, so if you are using the whole platform then Base Ping will already be installed and you can just start using it.

If you wish to integrate Base Ping into your custom backend, you can integrate the Base Ping Hono app by following the steps below.

1. Install

To install Base Ping into your custom backend:

pnpm

pnpm add github:oxyio-labs/base/packages/ping

npm

npm install github:oxyio-labs/base/packages/ping

2. Integrate

To integrate Base Ping into your custom backend:

import { app as pingApp } from "@oxyio/base-ping";

app = new Hono();
app.route('/', pingApp);
...

3. Test

To test Base Ping in your custom backend visit:

/.well-known/ping

You should receive the following as a response:

{
    "ping": "pong"
}