lukechilds
/
nostr-watch
mirror of https://github.com/lukechilds/nostr-watch.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
78 Commits
18 Branches
0 Tags
2.5 MiB
 
 
 
 
Tree: dc2d04c3c6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'dc2d04c3c6'
${ noResults }
Sandwich dc2d04c3c6
Update README.md 		2 years ago
nginx/conf.d Working refactor 2 years ago
src cleanup + geo support 2 years ago
.dockerignore feat: add Dockerfile 3 years ago
.gitignore add geo.yaml to gitignore 2 years ago
.prettierrc.yaml first version, reviving @rsbondi's work. 3 years ago
Dockerfile Working refactor 2 years ago
README.md Update README.md 2 years ago
babel.config.js Working refactor 2 years ago
codes.yaml fully ported to nostr-js 2 years ago
docker-compose.yaml fixed bugs 2 years ago
jsconfig.json Working refactor 2 years ago
onion.js Working refactor 2 years ago
package.json cleanup + geo support 2 years ago
relays.yaml upgrade to new inspector 2 years ago
vue.config.js kind of working, event handler is fragile and some messages aren't coming through 2 years ago
yarn-error.log Working refactor 2 years ago

README.md

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
  • Dynamic JSON API for online relays
  • 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, 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
  • Shareable Vue3 components

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.