Skip to content

sky-dtu/nostr-watch

Repository files navigation

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.

Goals

  • Rapidly learn Nostr Protocol Personal Goal
  • Tool that can assist in a visual understanding of Nostr for developers
  • Tool that can assist in onboarding for Users

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 Modal view In Progress
  • Relay Behavior Analysis In progress
  • NIP Checks In progress
  • Geo Checks (build-time) In progress
  • 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
  • General Housekeeping
  • Tests

Todo [Future]

  • Different views for different audiences (users, developers, relay operators)
  • Badges
  • Vue3 components package

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.

About

nostr registry and monitor web-client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 74.1%
  • JavaScript 21.2%
  • SCSS 4.5%
  • Dockerfile 0.1%
  • HTML 0.1%
  • Shell 0.0%