nodestr-relay icon indicating copy to clipboard operation
nodestr-relay copied to clipboard

⚠️ 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

  • [x] NIP 01
    • [x] sub-key
    • [x] unsub-key
    • [x] req-feed
    • [x] req-event
    • [x] req-key
    • [x] event (publish)
      • [x] set_metadata
      • [x] text_note
      • [x] 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