Go to file
2023-02-14 20:46:38 -06:00
.github chore: move files 2023-02-14 21:52:03 +00:00
.husky workspace with decoupled nostr package 2023-02-14 14:27:40 +01:00
docker fix: docker nginx config 2023-02-12 19:10:10 +00:00
packages chore: move files 2023-02-14 21:52:03 +00:00
.gitignore workspace with decoupled nostr package 2023-02-14 14:27:40 +01:00
Dockerfile workspace with decoupled nostr package 2023-02-14 14:27:40 +01:00
LICENSE chore: move files 2023-02-14 21:52:03 +00:00
package.json chore: move files 2023-02-14 21:52:03 +00:00
README.md add build command to readme 2023-02-14 20:46:38 -06:00
yarn.lock workspace with decoupled nostr package 2023-02-14 14:27:40 +01:00

Snort

Snort is a nostr UI built with React aiming for speed and efficiency.

Snort supports the following NIP's:

  • NIP-01: Basic protocol flow description
  • NIP-02: Contact List and Petnames (No petname support)
  • NIP-03: OpenTimestamps Attestations for Events
  • NIP-04: Encrypted Direct Message
  • NIP-05: Mapping Nostr keys to DNS-based internet identifiers
  • NIP-06: Basic key derivation from mnemonic seed phrase
  • NIP-07: window.nostr capability for web browsers
  • NIP-08: Handling Mentions
  • NIP-09: Event Deletion
  • NIP-10: Conventions for clients' use of e and p tags in text events
  • NIP-11: Relay Information Document
  • NIP-12: Generic Tag Queries
  • NIP-13: Proof of Work
  • NIP-14: Subject tag in text events
  • NIP-15: End of Stored Events Notice
  • NIP-19: bech32-encoded entities
  • NIP-20: Command Results
  • NIP-21: nostr: Protocol handler (web+nostr)
  • NIP-25: Reactions
  • NIP-26: Delegated Event Signing (Display delegated signings only)
  • NIP-28: Public Chat
  • NIP-36: Sensitive Content
  • NIP-40: Expiration Timestamp
  • NIP-42: Authentication of clients to relays
  • NIP-50: Search
  • NIP-51: Lists
  • NIP-65: Relay List Metadata

Running

This repository is a yarn workspace. To install dependencies, run yarn from the project root.

To build the nostr package, use either

$ yarn build

or, to automatically rebuild the nostr package if you are working on those files

$ cd packages/nostr
$ yarn watch 

To run the application, use either

$ yarn workspace @snort/app start

or

$ cd packages/app
$ yarn start

The nostr package must be built (this produces a packages/nostr/dist folder) in order to run the main application (packages/app).

If you encounter the below error, it indicates that the nostr package has not been built:

Module not found: Error: Can't resolve '@snort/nostr'