Skip to content

Latest commit

 

History

History
86 lines (65 loc) · 2.79 KB

README.md

File metadata and controls

86 lines (65 loc) · 2.79 KB
Raw

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

Follow me: npub1uac67zc9er54ln0kl6e4qp2y6ta3enfcg7ywnayshvlw9r5w6ehsqq99rx

LN & NIP-05: bread@sandwich.farm

nostr-watch 0.2

A client-side nostr network status built with Vue3, Pinia, nostr-tools, nostr-js and nostrwatch-js. Originally forked from fiatjaf/nostr-relay-registry but ended up being a rewrite.

nostr.watch aggregates data on nostr relays and the network in general to assist users, developers and relay operators.

Develop branch is deployed to https://next.nostr.watch

Relay Additions

It is now suggested to add relays simply by using them and publishing your kind 3 to really any known relay in good health. Most of the relays are discovered at runtime. This change is not yet communicated in production.

Relay additions via Github as the primary method of adding relays will be phased out for a number of reasons, expect this change with the 0.2 release.

If you are adding a relay, you need to use main as your base and submit your pr into main. Submissions to develop will still be approved, but your relay will not go online until a release. Whereas a PR into main will go live within 10 minutes of being merged.

PRs into develop will not recieve any notification about this requirement.

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
  • Favorite Relays
  • Extension Support
  • Nostr signing, individualized relay testing
  • Lighting Tips to Relay Operators
  • Relay Statistics
  • Relay Historical Data (partially implemented)
  • Discover relays at runtime
  • Discover geo at runtime
  • Relay Operator notes on Relay Pages
  • Result sharing
  • Login, Dashboard and Account Settings
  • Goal Optimized UX and GUI
  • Portable Relay Detail Page
  • Relay Alerts Service

Project setup

yarn install

Pre-build

Compiles and hot-reloads for development

Run once or whenever you want to update geo/discover relays

yarn prebuild

yarn serve

Compiles and minifies for production

This runs prebuild every time

yarn build

Lints and fixes files

yarn lint

Build Docker

yarn docker:build

Contributors