Skip to content

docs(readme): add 'Built to be forked' section explaining the rebrand path #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
owenwahlgren merged 1 commit into from
May 4, 2026
Merged

docs(readme): add 'Built to be forked' section explaining the rebrand path #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@

Next.js app. Point it at a running firn instance and you're done.

## Built to be forked

This is a **reference UI**, not a closed product. Fork it, rebrand it, ship it as your L1's official explorer:

- Swap `public/firn.png`, the colors in `app/globals.css` (OKLCH tokens), and the strings in `app/layout.tsx` for your branding.
- Add new pages under `app/` against firn's typed [OpenAPI client](./lib/api/) — `pnpm orval` regenerates from `openapi.json` whenever the firn API changes.
- Drop or rewrite any of the existing pages (`/blocks`, `/transactions`, `/address/[hash]`, `/tokens/[hash]`, `/genesis`, `/validators`) — none are load-bearing for the others.
- Wire your own decoded surfaces (e.g. a DEX-specific dashboard) by extending firn with a [custom decoder](https://github.com/ava-labs/firn/blob/main/docs/PLUGINS.md), then consuming the new endpoint here.

The explorer's job is to be a faithful renderer of firn's API. Everything cosmetic is yours to change.

## Run it

```bash
Expand Down
Loading