https://github.com/sandwichfarm/nostr-watch
nostr registry and monitor web-client
https://github.com/sandwichfarm/nostr-watch
nostr
Last synced: 7 months ago
JSON representation
nostr registry and monitor web-client
- Host: GitHub
- URL: https://github.com/sandwichfarm/nostr-watch
- Owner: sandwichfarm
- License: mit
- Created: 2022-11-24T11:19:11.000Z (over 2 years ago)
- Default Branch: next
- Last Pushed: 2024-12-06T09:38:49.000Z (7 months ago)
- Last Synced: 2024-12-06T10:30:03.667Z (7 months ago)
- Topics: nostr
- Language: TypeScript
- Homepage: https://nostr.watch
- Size: 59.4 MB
- Stars: 184
- Watchers: 4
- Forks: 482
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> @nostrwatch is in heavy development. Legacy nostr.watch is **in maintenance mode**.
# @nostrwatch
nostr.watch discovers, monitors and indexes nostr relays, and then publishes the results in the form of NIP-66. There are many shared packages between agents and clients. The ones that are useful external to nostr.watch are in `./libraries` and purpose built packages are in `./internal`.
# Stack
## agents
- **trawler** - finds new relays to monitor
- **nocapd** - monitors relays and publishes NIP-66 events
## gui
- **nostr.watch** - early stages
## libraries
- **nocap** - Runs basic checks on relays.
- **kit** - Attempts to simplify the process of aggregating NIP-66 events (overkill for general use!)
- **idb** - Purpose built IDB for more advanced NIP-66 usage (overkill for general use!)
### Development
a `CONTRIBUTE.md` will exist somewhere down the road. Since it's early stage, many details are not yet established, but here some details that are:
1. Primary branch for development @nostrwatch:next is `next`. Legacy is on `main` and the workflows are still functional for patches and legacy maintenance headaches.
2. Branching model: TBD (Trunk Based Development), trunk branch is `next` for early stage. Early alpha there will be long-standing branches for packages that are not yet in next. Once `@nostrwatch:next` reaches beta `next` will become `main` and there will be `trunk` branch.
3. GH Actions will be used for CI/CD
4. Issues will be reserved for actionable items, such as bugs. Anything requiring discussion lives in discussion until it's promoted to an issue.
5. PRs should be opened as a draft. When the PR is ready to be published commits should be squashed.
```
git clone https://github.com/sandwichfarm/nostr-watch.git
cd ./nostr-watch
yarn bootstrap
yarn install
```