Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.67 KB

README.md

File metadata and controls

50 lines (40 loc) · 1.67 KB
Raw

this project is alpha! changes are fast and hard. branching model and tests will come with beta.

nostr-watch

A client-side nostr network status built with Vue3, nostr-js and nostr-relay-inspector. Goal is to produce a client-side app that collects detailed information about nostr relays and the network in general to assist users, developers and relay operators alike

Features

  • Real-time relay status
  • Real-time, client-centric latency tests
  • Relay Identities
  • Static JSON API for all known relays shared via /relays.json
  • Detailed Relay View
  • Relay Behavior Analysis
  • NIP Checks
  • Geo Checks (build-time)
  • Optional Companion Backend for historical data and relay relief, front-end gracefully degrades if inaccessible.
  • "Best Relays for a User" and "Best Relays for a Developer" dynamic aggregate, the former based largely on a balance of Latency and NIP support, the latter based largely on NIP support. Unique results for each visitor

Todo [Road to Beta]

  • Expose all features in frontend
  • Clean codebase
  • Tests

Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Build Docker

yarn docker:build

About

Originally a fork of fiatjaf/nostr-relay-registry, but completely rewritten and connection functionality was ported to jb55/nostr-js.