@nostrwatch is in heavy development. Legacy nostr.watch is in maintenance mode.
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
.
- trawler - finds new relays to monitor
- nocapd - monitors relays and publishes NIP-66 events
- nostr.watch - early stages
- 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!)
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:
- Primary branch for development @nostrwatch:next is
next
. Legacy is onmain
and the workflows are still functional for patches and legacy maintenance headaches. - 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 betanext
will becomemain
and there will betrunk
branch. - GH Actions will be used for CI/CD
- Issues will be reserved for actionable items, such as bugs. Anything requiring discussion lives in discussion until it's promoted to an issue.
- 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