https://github.com/CodyTseng/nostr-relay-tray

a nostr relay for desktop
https://github.com/CodyTseng/nostr-relay-tray

electron nostr relay sqlite3

Last synced: 24 days ago
JSON representation

a nostr relay for desktop

• Host: GitHub
• URL: https://github.com/CodyTseng/nostr-relay-tray
• Owner: CodyTseng
• License: mit
• Created: 2024-01-27T07:47:07.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-10-23T15:25:18.000Z (about 2 months ago)
• Last Synced: 2024-10-25T00:58:08.928Z (about 2 months ago)
• Topics: electron, nostr, relay, sqlite3
• Language: TypeScript
• Homepage:
• Size: 2.14 MB
• Stars: 67
• Watchers: 1
• Forks: 5
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-nostr - nostr-relay-tray - relay-tray.svg?style=social) - a simple nostr relay tray app written in Electron (Clients / Relay lists)

README

        


  


  

  


  nostr-relay-tray

  


  




A simple nostr relay tray. For Mac, Windows, and Linux. 


powered by nostr-relay


## Features

- **Comprehensive**: A fully featured Nostr relay.

- **User-Friendly**: Start the relay with a single click.

- **Granular Control**: Manage which events to accept or reject with precision.

- **Cross-Platform**: Available for macOS, Windows, and Linux.

## Download

You can download the latest version from the [release page](https://github.com/CodyTseng/nostr-relay-tray/releases). If you want to use Apple Silicon version, you need to build it from the source code.

Because the app is not signed, you may need to allow it to run in the system settings.

## Build from source

You can also build the app from the source code.

> Note: Node.js >= 20 is required.

```bash

# Clone this repository

git clone https://github.com/CodyTseng/nostr-relay-tray.git

# Go into the repository

cd nostr-relay-tray

# Install dependencies

npm install

# Build the app

npm run build:mac

# or npm run build:win

# or npm run build:linux

```

The executable file will be in the `dist` folder.

## Screenshot

![screenshot](./screenshots/screenshot-1.png)

![screenshot](./screenshots/screenshot-2.png)

![screenshot](./screenshots/screenshot-3.png)

![screenshot](./screenshots/screenshot-4.png)

## Donate

If you like this project, you can buy me a coffee :) ⚡️ [email protected] ⚡️

## Icon Attribution

The ostrich element within the icon is sourced from [nostr_icons](https://github.com/satscoffee/nostr_icons). Special thanks to satscoffee for providing such a beautiful ostrich.

## License

MIT