⚠️ READ-ONLY. Please check https://github.com/Cameri/nostr-ts-relay for another Nostr relay written in TS.

Nodestr Relay - A nostr implementation in Node.js


Please refer to the official NIPs repo

  • NIP 01
    • sub-key
    • unsub-key
    • req-feed
    • req-event
    • req-key
    • event (publish)
      • set_metadata
      • text_note
      • recommend_server
  • NIP 02
  • NIP 03

How to install

  1. Clone & install
git clone https://github.com/Dolu89/nodestr-relay.git
cd nodestr-relay
yarn
node ace generate:key
  1. Create .env file
PORT=3333
HOST=0.0.0.0
NODE_ENV=development
APP_KEY=YourSecretKey  # result of 'node ace generate:key'
DB_CONNECTION=pg
PG_HOST=localhost
PG_PORT=5432
PG_USER=admin
PG_PASSWORD=admin
PG_DB_NAME=nostr
  1. DB migration
node ace migration:run
  1. Launch
yarn dev
  1. Profit!

ws://localhost:3333/ws