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.

61 lines
2.0 KiB

2 years ago
# nostr-watch
2 years ago
A client-side nostr network status built with Vue3, [nostr-js](http://github.com/jb55/nostr-js) and [dskvr/nostr-relay-inspector](http://github.com/). 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
- [x] 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
- [x] Real-time relay status
- [x] Real-time, client-centric latency tests
- [x] Relay Identities
- [x] JSON for 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, 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
- [ ] Shareable VUE components
and NIP validation scripts from [fiatjaf/nostr-tools](http://github.com/fiatjaf/nostr-tools). Originally a fork of [fiatjaf/nostr-relay-registry](http://github.com/fiatjaf/nostr-relay-registry), but completely rewritten and connection functionality was ported to [jb55/nostr-js](http://github.com/jb55/nostr-js).
2 years ago
## Project setup
```
yarn install
```
2 years ago
### Compiles and hot-reloads for development
```
yarn serve
```
2 years ago
### Compiles and minifies for production
```
yarn build
```
2 years ago
### Lints and fixes files
```
2 years ago
yarn lint
```
2 years ago
### Build Docker
```
yarn docker:build
```
2 years ago
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).