Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Dolu89/nodestr-relay
https://github.com/Dolu89/nodestr-relay
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Dolu89/nodestr-relay
- Owner: Dolu89
- Archived: true
- Created: 2021-01-12T17:54:01.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-19T14:17:28.000Z (almost 2 years ago)
- Last Synced: 2024-02-16T05:35:55.839Z (9 months ago)
- Language: TypeScript
- Homepage: wss://nodestr-relay.dolu.dev/ws
- Size: 104 KB
- Stars: 35
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nostr - nodestr - relay.svg?style=social) - a Node.js implementation (Deprecated / Client reviews and/or comparisons)
README
⚠️ READ-ONLY. Please check https://github.com/Cameri/nostr-ts-relay for another Nostr relay written in TS.
# Nodestr Relay - A [nostr](https://github.com/fiatjaf/nostr) implementation in Node.js
---
Please refer to the official [NIPs](https://github.com/fiatjaf/nostr/tree/master/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
``` bash
git clone https://github.com/Dolu89/nodestr-relay.git
cd nodestr-relay
yarn
node ace generate:key
```
2. 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
```
3. DB migration
```
node ace migration:run
```
4. Launch
``` bash
yarn dev
```
5. Profit!
`ws://localhost:3333/ws`