Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (38 loc) · 1.74 KB

Fiberplane Studio

FPX

website & docs

Fiberplane Studio is a local tool for building and debugging Hono APIs. It can make requests against your api, inspect relevant runtime information when things go wrong, and help you build on the fly with confidence.

Quick Start

Create Hono project

# Create a hono project, using cloudflare-workers runtime
npm create hono@latest my-hono-project
# > cloudflare-workers

Install the Fiberplane Hono Opentelemetry Library

cd my-hono-project
npm i @fiberplane/hono-otel@latest

Add it to your api

import { Hono } from "hono";
import { instrument } from "@fiberplane/hono-otel";

const app = new Hono();

app.get("/", (c) => c.text("Hello, Hono!"));

export default instrument(app);

Launch the Fiberplane Studio UI from your project directory

npx @fiberplane/studio@latest

Visit http://localhost:8788 to make requests to your api, and see your logs and traces come in as you test your app!


Studio is designed to be used in conjunction with the @fiberplane/hono-otel client library. You can read more about what it does in that project's README.

Contributing

See DEVELOPMENT.md for more details on how to run the Studio locally. Please get in touch via GitHub issues, or on the Fiberplane Discord, if you have any feedback or suggestions!

License

All code within the fpx repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT.