awesome-nostr/README.md

179 lines
14 KiB
Markdown
Raw Normal View History

2022-01-22 21:35:00 +00:00
# awesome-nostr
2022-12-20 18:50:08 +00:00
"nostr" stands for "**N**otes and **O**ther **S**tuff **T**ransmitted by
**R**elays" and is an open protocol for censorship-resistant global networks
created by [@fiatjaf](https://github.com/fiatjaf).
2022-01-23 00:30:21 +00:00
## Protocol
2022-12-20 18:50:08 +00:00
- [nostr](https://github.com/nostr-protocol/nostr) - overview and FAQ
2022-07-28 14:27:28 +00:00
- [NIPs](https://github.com/nostr-protocol/nips) - the "**N**ostr **I**mplementation **P**ossibilities" describe the protocol in technical detail
- [nostr, a basic tour](https://github.com/rajarshimaitra/rust-nostr/blob/main/VISION.md) - an intro to nostr
- [Nostr: Solucionando la censura de una vez por todas](https://estudiobitcoin.com/nostr-solucionando-la-censura-de-una-vez-por-todas/)
2022-12-20 20:00:23 +00:00
- [UseNostr](https://usenostr.org) - A small guide for anyone who wants to learn more about how nostr works and what it can do.
2022-01-23 00:36:05 +00:00
## Relays
2022-12-20 18:50:08 +00:00
Relays are (so far) application agnostic. You can run your own or use any or all
of the public instances.
2022-01-23 11:26:57 +00:00
### Implementations
2022-12-20 18:50:08 +00:00
- [NNostr](https://github.com/Kukks/NNostr) - a C# relay
- [nostr-rs-relay](https://sr.ht/~gheartsfield/nostr-rs-relay/) - a minimalistic relay written in Rust that saves data on SQLite
- [Relayer Basic](https://github.com/fiatjaf/relayer/tree/master/basic) - a simple relay based on _relayer_ backed by Postgres
- [nodestr](https://github.com/Dolu89/nodestr-relay) - a Node.js implementation
- [expensive relay](https://github.com/fiatjaf/expensive-relay) - a relay that requires payment for registration
- [me.untethr.nostr-relay](https://github.com/atdixon/me.untethr.nostr-relay) - a relay written in Clojure
- [Minds Nostr Relay](https://gitlab.com/minds/infrastructure/nostr-relay) - a relay for [Minds](https://www.minds.com), an open-source social network
- [Minds Engine - Nostr](https://gitlab.com/minds/engine/-/tree/master/Core/Nostr) - relevant Minds API code for reading/writing Minds posts using Nostr
- [NostrPostr Relay](https://github.com/Giszmo/NostrPostr/tree/master/NostrRelay) - a Kotlin Relay supporting both SQLite and Postgresql
2022-12-20 18:50:08 +00:00
- [nostrypy](https://github.com/monty888/nostrpy) - relay, client, and other tooling in python
2022-08-14 23:42:22 +00:00
- [nostr-ts-relay](https://github.com/Cameri/nostr-ts-relay) - a nostr relay written in Typescript backed by PostgreSQL
- [nostr_relay](https://code.pobblelabs.org/fossil/nostr_relay/) a nostr relay written in python, backed by SQLite
- [søstr](https://github.com/metasikander/s0str) a private nostr relay written in rust, saves all notes from one pubkey and publish them to anyone that requests them
2022-01-23 00:30:21 +00:00
### Instances
2022-12-20 18:50:08 +00:00
Instances are plenty and their availability may vary but these projects track
them:
2022-12-20 18:50:08 +00:00
- [nostr relay registry](https://nostr-registry.netlify.app/) - real-time checking of status of some known relays
- [nostr.info](https://nostr.info/) - real-time checking of status of some known relays
2022-11-25 11:19:53 +00:00
- [nostr.watch](https://nostr.watch) - real-time checking of status of some known relays with advanced checks.
2022-01-23 00:41:57 +00:00
## Clients
2022-12-20 18:50:08 +00:00
- [branle](https://github.com/fiatjaf/branle) - a Twitter-like client with chat. Some instances:
- [branle.netlify.app](https://branle.netlify.app/) - by fiatjaf
- [nostr.rocks](https://nostr.rocks/)
- [branle.wlvs.space](https://branle.wlvs.space/)
- [branle tor](http://hbn4yzl3qkzi3qpse6nvljbduzcdecaq76tbcfjfzmoaik3q3uryxuad.onion/3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d) - on tor
- [astral](https://github.com/monlovesmango/astral) - a branle fork with global feed and UI makeover
- [astral.ninja](https://astral.ninja/)
- [damus](https://github.com/damus-io/damus) - a twitter-like nostr client for iOS and MacOS
- [damus on testflight](https://testflight.apple.com/join/CLwjLxWl)
2022-12-20 18:50:08 +00:00
- [more-speech](https://github.com/unclebob/more-speech) - desktop client for nostr written in Clojure
- [futr](https://github.com/prolic/futr) - nostr client desktop app written in Haskell
- [nvote](https://github.com/rdbell/nvote), Nvote is a decentralized, vote-driven community similar to services like Reddit and HackerNews. Nvote is powered by nostr
- [nvote.co](https://nvote.co/)
- [Minds](https://www.minds.com/) - open source social network. Supports reading and creating posts using the Nostr protocol
- [alphaama](https://alphaama.com/) - playground by [Tiago Balas](https://github.com/eskema)
- [Jester](https://jesterui.github.io/) - Chess over nostr
- [Sendstr](https://sendstr.com/) - shared clipboard between devices over nostr
- [noscl](https://github.com/fiatjaf/noscl) - a basic command-line client written in Go
- [loquaz](https://github.com/emeceve/loquaz) - a desktop app written in Rust for direct encrypted chat
2022-12-18 21:40:17 +00:00
- [nostr console](https://github.com/vishalxl/nostr_console) - a nostr command line client written in Dart. Binaries available for Windows, Linux, and MacOS
- [anigma](https://github.com/brilliancebitcoin/nostrgram) - A clone of telegram built on nostr
- [ArcadeCity](https://github.com/ArcadeCity/app) - Public group chats and P2P services (WIP) over nostr
2022-12-18 21:40:17 +00:00
- [second exchange](https://github.com/cynsar-foundation/second.exchange) - an experiment to work out something of like medium, something of creator economy where users are rewarded for engaging in quality discussion and most importantly engaging in governance-related discussion
2022-09-21 21:55:05 +00:00
- [scalastr](https://github.com/benthecarman/scalastr) - A barebones nostr client written in scala
2022-10-30 15:36:22 +00:00
- [Nostros](https://github.com/KoalaSat/nostros) - A nostr mobile client for Android
2022-12-18 21:40:17 +00:00
- [NostrEmitter](https://github.com/cmdruid/nostr-emitter)- Simple E2E encrypted client and EventEmitter object
- [Lightning.Pub](https://github.com/shocknet/Lightning.Pub)- A nostr daemon for Lightning nodes
- [shockwallet](https://github.com/shocknet/wallet2)- A Lightning wallet that uses nostr and lnurl to connect to nodes
2022-12-04 19:57:42 +00:00
- [coracle](https://github.com/staab/coracle) - A nostr web client
2022-12-09 00:55:20 +00:00
- [nostrweb](https://git.qcode.ch/nostr/nostrweb) - another nostr web client in vanilla JS
- [nostr.ch](https://nostr.ch/) - live instance
2022-12-18 21:40:17 +00:00
- [Bija](https://github.com/BrightonBTC/bija) - A desktop client written in python. Currently Linux only
- [Nosky](https://github.com/KotlinGeekDev/Nosky) - A native Android client for Nostr. Still in development
- [Stackerstan](https://stackerstan.org) - A decentralised organisation built on Bitcoin and Nostr, implemented as a replicated state machine in Golang
- [nostr-java](https://github.com/tcheeric/nostr-java) - A nostr client API written in java, for generating, signing and publishing events to relays
- [bolt.fun](https://makers.bolt.fun/feed) - A bitcoin lightning makers community that supports reading and creating comments using Nostr
2022-12-25 04:55:35 +00:00
- [iris](https://iris.to) - A nostr web client
- [gossip](https://github.com/mikedilger/gossip) - A desktop client in rust presented with egui
2022-12-20 18:50:08 +00:00
2022-10-05 17:48:54 +00:00
### Client reviews and/or comparisons
2022-12-20 18:50:08 +00:00
2022-10-05 17:47:42 +00:00
- Feature [comparison of Nostr clients as of mid-2022](https://github.com/vishalxl/Nostr-Clients-Features-List)
## Libraries
2022-12-20 18:50:08 +00:00
- [nostr-ruby](https://github.com/dtonon/nostr-ruby) - a Ruby implementation of the nostr protocol
- [NNostr.Client](https://github.com/Kukks/NNostr) - a C# Nostr library for use by clients
- [nostr-tools](https://github.com/fiatjaf/nostr-tools) - a JavaScript client that abstracts the relay management code for use by clients
- [nostrgg/client](https://github.com/nostrgg/nostrgg-client) - a TypeScript library for the client that handles the hard stuff
- [nostrgg/react](https://github.com/nostrgg/nostrgg-react) - React Hooks for Nostr
- [go-nostr](https://github.com/fiatjaf/go-nostr) - a Go library that implements relay management, plus event encoding and signing utils
2022-11-18 10:25:19 +00:00
- [nostr_rust](https://github.com/0xtlt/nostr_rust) - Functional Rust implementation of the nostr protocol
2022-11-26 05:58:52 +00:00
- [nostr-js](https://github.com/jb55/nostr-js) - a javascript implementation of the nostr protocol
- [nostr-rs](https://github.com/futurepaul/nostr-rs) - a Rust implementation of the nostr protocol
- [nostr-rs-sdk](https://github.com/yukibtc/nostr-rs-sdk) - Nostr `protocol` implementation, `SDK`, and `FFI` written in Rust
- [relayer](https://github.com/fiatjaf/relayer) - a server framework for writing custom relays
- [NostrPostr](https://github.com/Giszmo/NostrPostr) - a Kotlin Nostr library for clients or relays
2022-08-03 23:28:11 +00:00
- [python-nostr](https://github.com/jeffthibault/python-nostr) - a python library for making clients
2022-08-16 19:07:21 +00:00
- [nostr-bot](https://github.com/slaninas/nostr-bot) - a Rust library for writing bots
2022-09-26 12:32:00 +00:00
- [NostrKit](https://github.com/cnixbtc/NostrKit) - a Swift library for interacting with relays
- [nostr-relay-inspector](https://github.com/dskvr/nostr-relay-inspector) - A library that returns useful information about relays based on nostr-js
2022-12-20 18:50:08 +00:00
- [schorr_snap](https://github.com/neeboo/schnorr_snap) - A snap plugin for Metamask Flask, supports nostr
2022-12-24 18:38:49 +00:00
- [nostr-deno](https://github.com/KiPSOFT/nostr-deno) - a client library for Deno javascript runtime.
- [nostr-types](https://github.com/mikedilger/nostr-types) - a rust library defining types useful for the nostr protocol
## Bridges and Gateways
2022-12-20 18:50:08 +00:00
- [rsslay](https://github.com/fiatjaf/rsslay) - a bridge that puts RSS feeds into Nostr
- [smtp nostr gateway ](https://github.com/Cameri/smtp-nostr-gateway) - a bridge that forwards emails to pubkeys as encrypted direct messages
- [matrix-nostr-bridge](https://github.com/8go/matrix-nostr-bridge) a simple Matrix-to-Nostr or Nostr-to-Matrix bridge
## Tools
2022-12-20 18:50:08 +00:00
2022-11-26 06:00:51 +00:00
- [git-nostr-tools](http://git.jb55.com/git-nostr-tools) - A cli tool for sending code patches over nostr
2022-11-26 06:02:03 +00:00
- [nostr-cln-events](http://git.jb55.com/nostr-cln-events) - A CLN plugin to push clightning node events to nostr
- [nostr registry](https://codeberg.org/rsbondi/nostr-registry) - a database of known relays with their uptime and NIP support tables
2022-09-16 22:48:31 +00:00
- [nostr-fzf](https://github.com/Cameri/nostr-fzf) - Nostr Directory; a tool for searching usernames and channels
2022-11-26 05:59:44 +00:00
- [nostr-notify](https://github.com/jb55/nostr-notify) - desktop nostr notifications using libnotify
- [nostr-launch](https://codeberg.org/rsbondi/nostr-launch) - a tool for launching a bunch of relays and clients locally for development and testing
- [nos2x - nostr signer extension](https://github.com/fiatjaf/nos2x) - a browser extension for signing events on 3rd party site without sharing your private keys with them
- [nostr GitHub Action](https://github.com/theborakompanioni/nostr-action) - send events from GitHub Actions
- [nostrefresh](https://github.com/melvincarvalho/nostrefresh) - simple refresh function for nostr web pages
- [anonroom](https://github.com/vinliao/anonroom) - anonymous chat room inside nostr
- [nostril](https://github.com/jb55/nostril) - C cli tool for creating nostr events
- [nostr-rs-relay-compose](https://github.com/vdo/nostr-rs-relay-compose) - a Docker compose deployment for nostr-rs-relay with SSL support based on Traefik
- [tostr](https://github.com/slaninas/tostr) - a twitter to nostr bot
2022-12-18 22:28:45 +00:00
- [nostr.guru](https://nostr.guru/) - a nostr web gateway for viewing events by their ID
- [nostrandom.netlify.app](https://nostrandom.netlify.app/) - generate publish-able Nostr event with random keys
- [nashboard](https://github.com/vinliao/nashboard) and [here](https://nashboard.space/) - a Nostr network dashboard with network statistics
- [nostr army knife](https://nostr-army-knife.netlify.app/) - nostr army knife by fiatjaf
2022-08-20 23:36:43 +00:00
- [joinstr](https://github.com/1440000bytes/joinstr) - coinjoin implementation using nostr
2022-09-04 21:51:11 +00:00
- [ndxstr](https://github.com/ArcadeCity/ndxstr) - nostr's layer 2 indexing nodes, with more advanced querying capability than currently supported by relays
2022-09-16 13:20:10 +00:00
- [nostrillery](https://github.com/Cameri/nostrillery) - a tool for running performance tests against Nostr relays
2022-11-01 16:52:29 +00:00
- [nostr-terminal](https://github.com/cmdruid/nostr-terminal) - SSH-like access to your machine via web terminal, powered by Nostr.
2022-12-04 20:01:25 +00:00
- [nostcat](https://github.com/blakejakopovic/nostcat) - cat-like nostr client for scripting and debugging written in Rust
2022-11-20 08:45:16 +00:00
- [rana](https://github.com/grunch/rana) - Nostr mining pubkey with multi threading
2022-12-04 19:53:57 +00:00
- [nostreq](https://github.com/blakejakopovic/nostreq) - Nostr relay event request generator
- [nostr.io](https://nostr.io/) - network statistics with last published notes, top 50 publishers, and top 50 followed users
- [nostr-commander](https://github.com/8go/nostr-commander-rs) - simple but convenient CLI-based Nostr app for following users, sending DMs, etc.
2022-12-17 07:00:02 +00:00
- [nostr.directory](https://github.com/pseudozach/nostr.directory) - searchable database of nostr users and their other social media links.
2022-12-18 12:27:11 +00:00
- [nostr-tool](https://github.com/0xtrr/nostr-tool) - Rust CLI tool to generate and publish events
- [nostrplebs](https://nostrplebs.com) - A NIP-05 ID registration service.
2022-01-23 00:30:21 +00:00
2022-12-15 14:20:45 +00:00
## Browser extensions
2022-12-20 18:50:08 +00:00
2022-12-18 21:40:17 +00:00
Allow you to sign Nostr events on web-apps without having to give them your keys
2022-12-20 18:50:08 +00:00
- [Alby](https://getalby.com) - Bitcoin Lightning app with nostr support
- [nos2x](https://github.com/fiatjaf/nos2x) - Nostr Signer Extension
- [wen](https://github.com/fiatjaf/wen) - browser extension for website enhancer with nostr
- [Blockcore](https://github.com/block-core/blockcore-wallet) - Multi wallet browser extension with nostr support
2022-12-15 14:20:45 +00:00
## Community
2022-12-20 18:50:08 +00:00
Outside of nostr itself, you find the community on:
2022-12-20 18:50:08 +00:00
- [nostr telegram group](https://t.me/nostr_protocol) - a telegram group for nostr protocol discussion
- [nostr reddit](https://www.reddit.com/r/nostr/) - a subreddit for nostr related discussion
2022-01-23 11:26:57 +00:00
2022-12-20 18:50:08 +00:00
## Tutorials
2022-12-18 21:17:28 +00:00
- [Set up a nostr relay server in under 5 minutes ](https://andreneves.xyz/p/set-up-a-nostr-relay-server-in-under)
2022-12-20 18:50:08 +00:00
- [nostr workshop with super testnet](https://www.youtube.com/watch?v=HbicnlCXg_Y)
2022-12-18 21:17:28 +00:00
## Other links
2022-12-20 18:50:08 +00:00
- [nostr on YouTube](https://www.youtube.com/results?search_query=nostr+protocol)
- [vanilla-js-nostr](https://github.com/supertestnet/vanilla-js-nostr) - a demo of posting and viewing a feed in nostr using vanilla javascript
2022-12-20 18:50:08 +00:00
- [nostr playground in Ruby](https://github.com/dtonon/nostr-ruby-playground)
- [search posts by keyword](https://realsearch.cc) - posts from major relays indexed and searchable in real-time
2022-12-18 20:54:07 +00:00
2022-12-18 21:29:19 +00:00
Data for this list is contributed by the community and curated by [@aaaljaz](https://twitter.com/aaaljaz).