2023-01-25 15:19:47 +00:00
|
|
|
## Snort
|
2023-01-23 11:15:29 +00:00
|
|
|
|
2023-02-13 10:02:26 +01:00
|
|
|
Snort is a nostr UI built with React aiming for speed and efficiency.
|
2023-01-23 11:15:29 +00:00
|
|
|
|
2023-01-28 22:43:56 +01:00
|
|
|
Snort supports the following NIP's:
|
|
|
|
|
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-01: Basic protocol flow description
|
|
|
|
|
- [x] NIP-02: Contact List and Petnames (No petname support)
|
|
|
|
|
- [ ] NIP-03: OpenTimestamps Attestations for Events
|
|
|
|
|
- [x] NIP-04: Encrypted Direct Message
|
|
|
|
|
- [x] NIP-05: Mapping Nostr keys to DNS-based internet identifiers
|
2023-03-10 14:54:25 -05:00
|
|
|
- [x] NIP-06: Basic key derivation from mnemonic seed phrase
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-07: `window.nostr` capability for web browsers
|
2023-01-23 16:31:59 +01:00
|
|
|
- [x] NIP-08: Handling Mentions
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-09: Event Deletion
|
|
|
|
|
- [x] NIP-10: Conventions for clients' use of `e` and `p` tags in text events
|
2023-01-25 15:19:47 +00:00
|
|
|
- [x] NIP-11: Relay Information Document
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-12: Generic Tag Queries
|
|
|
|
|
- [ ] NIP-13: Proof of Work
|
|
|
|
|
- [ ] NIP-14: Subject tag in text events
|
|
|
|
|
- [x] NIP-15: End of Stored Events Notice
|
2023-04-07 18:57:33 +01:00
|
|
|
- [x] NIP-18: Reposts
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-19: bech32-encoded entities
|
|
|
|
|
- [x] NIP-20: Command Results
|
2023-02-14 10:34:43 +00:00
|
|
|
- [x] NIP-21: `nostr:` Protocol handler (`web+nostr`)
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-25: Reactions
|
|
|
|
|
- [x] NIP-26: Delegated Event Signing (Display delegated signings only)
|
2023-04-07 18:57:33 +01:00
|
|
|
- [x] NIP-27: Text note references (Parsing only)
|
2023-01-23 11:15:29 +00:00
|
|
|
- [ ] NIP-28: Public Chat
|
2023-04-07 18:57:33 +01:00
|
|
|
- [x] NIP-36: Sensitive Content
|
2023-01-23 11:15:29 +00:00
|
|
|
- [ ] NIP-40: Expiration Timestamp
|
2023-04-07 18:57:33 +01:00
|
|
|
- [x] NIP-42: Authentication of clients to relays
|
2023-01-28 22:43:56 +01:00
|
|
|
- [x] NIP-50: Search
|
|
|
|
|
- [x] NIP-51: Lists
|
2023-03-09 11:13:10 +01:00
|
|
|
- [x] NIP-58: Badges
|
2023-02-10 20:23:52 +01:00
|
|
|
- [x] NIP-65: Relay List Metadata
|
2023-04-07 18:57:33 +01:00
|
|
|
- [ ] NIP-78: App specific data
|
2023-02-13 10:02:26 +01:00
|
|
|
|
|
|
|
|
### Running
|
|
|
|
|
|
|
|
|
|
This repository is a yarn workspace. To install dependencies, run `yarn` from the project root.
|
|
|
|
|
|
2023-02-15 14:14:55 -06:00
|
|
|
To run the application, use
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ yarn start
|
2023-02-13 10:02:26 +01:00
|
|
|
```
|
|
|
|
|
|
2023-02-15 14:14:55 -06:00
|
|
|
To build the application and nostr package, use
|
2023-02-13 10:02:26 +01:00
|
|
|
|
2023-02-15 14:14:55 -06:00
|
|
|
```
|
|
|
|
|
$ yarn build
|
2023-02-13 10:02:26 +01:00
|
|
|
```
|
2023-02-20 14:18:41 +00:00
|
|
|
|
|
|
|
|
### Translations
|
|
|
|
|
|
2023-02-27 14:41:07 +00:00
|
|
|
[](https://crowdin.com/project/snort)
|
|
|
|
|
|
2023-02-20 14:18:41 +00:00
|
|
|
Translations are managed on [Crowdin](https://crowdin.com/project/snort)
|
|
|
|
|
|
|
|
|
|
To extract translations run:
|
|
|
|
|
```bash
|
|
|
|
|
yarn workspace @snort/app intl-extract
|
|
|
|
|
yarn workspace @snort/app intl-compile
|
|
|
|
|
```
|
|
|
|
|
|
2023-03-09 11:13:10 +01:00
|
|
|
This will create the source file `packages/app/src/translations/en.json`
|
