2023-01-25 15:19:47 +00:00
|
|
|
## Snort
|
2023-01-23 11:15:29 +00:00
|
|
|
|
2023-02-13 09:02:26 +00: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 21:43:56 +00: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 19:54:25 +00: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 15:31:59 +00: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-08-28 16:36:26 +00:00
|
|
|
- [x] NIP-13: Proof of Work
|
2023-01-23 11:15:29 +00:00
|
|
|
- [ ] NIP-14: Subject tag in text events
|
2023-04-07 17:57:33 +00:00
|
|
|
- [x] NIP-18: Reposts
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-19: bech32-encoded entities
|
2023-02-14 10:34:43 +00:00
|
|
|
- [x] NIP-21: `nostr:` Protocol handler (`web+nostr`)
|
2023-09-19 08:51:19 +00:00
|
|
|
- [x] NIP-23: Long form content
|
2023-01-23 11:15:29 +00:00
|
|
|
- [x] NIP-25: Reactions
|
|
|
|
|
- [x] NIP-26: Delegated Event Signing (Display delegated signings only)
|
2023-08-28 16:36:26 +00:00
|
|
|
- [x] NIP-27: Text note references
|
2023-11-20 10:39:58 +00:00
|
|
|
- [x] NIP-28: Public Chat
|
2023-05-15 20:56:31 +00:00
|
|
|
- [x] NIP-30: Custom Emoji
|
2023-08-28 16:36:26 +00:00
|
|
|
- [x] NIP-31: Alt tag for unknown events
|
2023-04-07 17:57:33 +00:00
|
|
|
- [x] NIP-36: Sensitive Content
|
2023-09-18 09:05:36 +00:00
|
|
|
- [x] NIP-38: User Statuses
|
2023-09-19 08:51:19 +00:00
|
|
|
- [ ] NIP-39: External Identities
|
2023-01-23 11:15:29 +00:00
|
|
|
- [ ] NIP-40: Expiration Timestamp
|
2023-04-07 17:57:33 +00:00
|
|
|
- [x] NIP-42: Authentication of clients to relays
|
2023-06-16 08:45:05 +00:00
|
|
|
- [x] NIP-44: Versioned encryption
|
2023-08-28 16:36:26 +00:00
|
|
|
- [x] NIP-46: Nostr connect (+bunker)
|
|
|
|
|
- [x] NIP-47: Nostr wallet connect
|
2023-01-28 21:43:56 +00:00
|
|
|
- [x] NIP-50: Search
|
|
|
|
|
- [x] NIP-51: Lists
|
2023-08-28 16:36:26 +00:00
|
|
|
- [x] NIP-53: Live Events
|
2023-09-19 08:51:19 +00:00
|
|
|
- [x] NIP-57: Zaps
|
2023-03-09 10:13:10 +00:00
|
|
|
- [x] NIP-58: Badges
|
2023-06-16 08:45:05 +00:00
|
|
|
- [x] NIP-59: Gift Wrap
|
2023-02-10 19:23:52 +00:00
|
|
|
- [x] NIP-65: Relay List Metadata
|
2023-09-19 08:51:19 +00:00
|
|
|
- [x] NIP-75: Zap Goals
|
2023-11-20 10:39:58 +00:00
|
|
|
- [x] NIP-78: App specific data
|
2023-09-19 08:51:19 +00:00
|
|
|
- [ ] NIP-89: App handlers
|
|
|
|
|
- [x] NIP-94: File Metadata
|
2023-11-20 15:36:01 +00:00
|
|
|
- [x] NIP-96: HTTP File Storage Integration (Draft)
|
2023-08-28 16:36:26 +00:00
|
|
|
- [x] NIP-98: HTTP Auth
|
2023-02-13 09:02:26 +00:00
|
|
|
|
|
|
|
|
### Running
|
|
|
|
|
|
|
|
|
|
This repository is a yarn workspace. To install dependencies, run `yarn` from the project root.
|
|
|
|
|
|
2023-02-15 20:14:55 +00:00
|
|
|
To run the application, use
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ yarn start
|
2023-02-13 09:02:26 +00:00
|
|
|
```
|
|
|
|
|
|
2023-11-20 10:39:58 +00:00
|
|
|
To build the application and system packages, use
|
2023-02-13 09:02:26 +00:00
|
|
|
|
2023-02-15 20:14:55 +00:00
|
|
|
```
|
|
|
|
|
$ yarn build
|
2023-02-13 09:02:26 +00:00
|
|
|
```
|
2023-02-20 14:18:41 +00:00
|
|
|
|
2024-02-04 05:27:57 +00:00
|
|
|
Tauri desktop application:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
# install dependencies
|
|
|
|
|
yarn
|
|
|
|
|
|
|
|
|
|
# develop
|
|
|
|
|
yarn tauri dev
|
|
|
|
|
|
|
|
|
|
# build
|
|
|
|
|
yarn tauri build
|
|
|
|
|
```
|
|
|
|
|
|
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:
|
2023-07-22 18:37:46 +00:00
|
|
|
|
2023-02-20 14:18:41 +00:00
|
|
|
```bash
|
2023-11-20 10:39:58 +00:00
|
|
|
yarn pre:commit
|
2023-02-20 14:18:41 +00:00
|
|
|
```
|
|
|
|
|
|
2023-03-09 10:13:10 +00:00
|
|
|
This will create the source file `packages/app/src/translations/en.json`
|
