nostream/README.md
2022-10-18 23:11:29 -04:00

1.5 KiB

nostr-ts-relay

This is a nostr relay, written in Typescript.

The project master repository is available on GitHub.

Features

NIPs with a relay-specific implementation are listed here.

  • NIP-01: Basic protocol flow description
  • NIP-02: Contact list and petnames
  • NIP-03: OpenTimestams Attestations for Events
  • NIP-04: Encrypted Direct Message
  • NIP-05: Mapping Nostr keys to DNS identifiers
  • NIP-09: Event deletion
  • NIP-11: Relay information document
  • NIP-12: Generic tag queries
  • NIP-13: Proof of Work
  • NIP-15: End of Stored Events Notice
  • NIP-16: Event Treatment
  • NIP-25: Reactions

Requirements

  • PostgreSQL
  • Node
  • Typescript

Quick Start

Set the following environment variables:

DB_HOST=localhost
DB_PORT=5432
DB_NAME=nostr-ts-relay
DB_USER=postgres
DB_PASSWORD=postgres

Create nostr-ts-relay database:

$ psql -h $DB_HOST -p $DB_PORT -U $DB_USER -W
postgres=# create database nostr-ts-relay;
postgres=# quit

Install dependencies:

npm install

Run migrations:

npm run db:migrate

To start in development mode:

npm run dev

Configuration

TBD

Dev Channel

For development discussions, please feel free to use the Nostr Telegram Channel.

License

This project is MIT licensed.