💧 mizu (水)

Japanese for "water"

Description

This has an api and a frontend that can consume telemetry data from a Hono app.

To connect your Hono app to the api, you'll need to add the code in the client-library folder to your Hono app. This will send telemetry data to the api.

Worth noting is that the api connects to a Neon (postgres) database. There are setup and configuration steps for this in api/README.md.

The frontend is a React + Typescript + Tailwind app that uses shadcn/ui components. For more info on the frontend, see: frontend/README.md.

Setup

You'll want to

1. Run the code in this repo, and then
2. Add some client code to a Hono app

The next two sections take you through how to do this.

Spinning up the database, api, and dashboard

1. Clone this repo
2. Create an account with Neon You can skip their onboarding, you do not need to create a project immediately
3. Install the Neon CLI
4. cd api and spin up the api (follow instructions in api/README)
5. Check the api is running on http://localhost:8788
6. cd frontend in a separate shell, and spin up the frontend (follow instructions in in frontend/README)
7. Check the frontend is running on http://localhost:5173

Adding Mizu to your Hono project

Follow the instructions in the client-library README to add Mizu telemetry to your Hono project.

Developing

I turned off Biome. But we could always add it? Idk.