2022-12-15 18:31:47 +00:00
# What is this?
2022-11-24 19:47:03 +00:00
2022-12-24 00:02:01 +00:00
Coracle is a web client for the Nostr protocol. While Nostr is useful for many things, Coracle focuses on providing a high-quality social media experience. Check it out at [coracle.social ](https://coracle.social ).
2022-12-15 18:31:47 +00:00
[Dufflepud ](https://github.com/staab/dufflepud ) is a companion server which you can self-host. It helps Coracle with things like link previews and image uploads.
2022-12-24 00:02:01 +00:00
If you like Coracle and want to support its development, you can donate sats via [Geyser ](https://geyser.fund/project/coracle ).
2022-12-15 18:31:47 +00:00
# Features
2022-11-24 19:47:03 +00:00
2022-11-27 03:34:28 +00:00
- [x] Chat
- [x] Threads/social
2022-12-03 20:26:09 +00:00
- [x] Search
2022-12-15 13:55:12 +00:00
- [x] Notifications
2022-12-06 05:46:40 +00:00
- [x] Link previews
2022-12-14 06:01:26 +00:00
- [x] Add notes, follows, likes tab to profile
2022-12-30 23:52:29 +00:00
- [x] Mentions
2023-01-16 23:12:10 +00:00
- [x] Persist and load relay list
2023-01-17 00:09:36 +00:00
- [x] NIP 05
2023-01-21 19:49:09 +00:00
- [x] Direct messages using NIP 04
2023-02-06 11:42:42 +00:00
# Snacks
- [ ] Add nip05 verification on feed
- [ ] Linkify follow/followers numbers
- [ ] Support key delegation
- https://github.com/nbd-wtf/nostr-tools/blob/master/nip26.ts
- [ ] Add keyword mutes
- [ ] Add encrypted settings storage using nostr events
- [ ] Attachments (a tag w/content type and url)
- [ ] Linkify bech32 entities w/ NIP 21 https://github.com/nostr-protocol/nips/blob/master/21.md
- [ ] Sign in as user with one click to view things from their pubkey's perspective - do this with multiple accounts
# Missions
2022-12-15 18:31:47 +00:00
- [ ] Image uploads
2023-01-16 18:34:18 +00:00
- Use dufflepud. Default will charge via lightning and have a tos, others can self-host and skip that.
2023-01-16 20:02:18 +00:00
- Add banner field to profile
2023-02-06 11:42:42 +00:00
- [ ] Allow users to select which relay they're reading from, allow more advanced custom feeds ala tweetdeck
2023-01-07 17:48:01 +00:00
- [ ] Add relay selector when publishing a note
2023-02-06 11:42:42 +00:00
- [ ] Support invoices, tips, zaps https://twitter.com/jb55/status/1604131336247476224
- [ ] Separate settings for read, write, and broadcast relays based on NIP 65
- [ ] Deploy coracle relay
- [ ] Release to android with https://svelte-native.technology/docs
2023-01-11 17:15:58 +00:00
- [ ] Add no-relay gossip
- Capture certain events in a local db
- File import/export from db, NFC transfer
2023-01-16 23:12:10 +00:00
- Save user notes to db
2022-12-16 17:45:58 +00:00
2023-02-06 11:42:42 +00:00
# Maintenance
2023-01-21 19:15:10 +00:00
2023-02-06 11:42:42 +00:00
- [ ] Fix login flow
- [ ] Fix navigation
- Stack views?
- Put user detail in a modal?
- ReplaceState for settings modals?
2023-02-06 17:50:44 +00:00
- [ ] Use nip 56 for reporting
- https://github.com/nostr-protocol/nips/pull/205#issuecomment-1419234230
2023-02-04 19:01:47 +00:00
- [ ] Mentions are sorta weird, usually mention self
2023-01-25 17:36:42 +00:00
- [ ] Change network tab to list relays the user is connected to
2023-01-21 19:15:10 +00:00
- [ ] Sync mentions box and in-reply mentions
2023-01-21 21:49:06 +00:00
- [ ] Add petnames for channels
- [ ] Add notifications for chat messages
2023-01-21 19:15:10 +00:00
2022-12-24 00:02:01 +00:00
# Changelog
2023-02-06 16:41:48 +00:00
## 0.2.10
- [x] Fixed likes not showing up in alerts
- [x] Raised threshold for pool to 2 so we don't have such a small amount of results
- [x] Wait for profile info on login, navigate to network by default
2023-02-06 21:09:08 +00:00
- [x] Fix mention selection, inheritance, and inclusion in notes
- [x] Parse links without http at the beginning
2023-02-06 16:41:48 +00:00
2023-02-06 11:42:42 +00:00
## 0.2.9
2023-02-06 16:41:48 +00:00
- [x] Fixed a bug in pool.subscribe which was causing requests to wait for all connections
- [x] Added typescript with pre-commit hook
- [x] Fixed layout for chat, person pages
2023-02-06 11:42:42 +00:00
- [x] Parse relays for kind 3
2023-01-24 04:15:49 +00:00
## 0.2.8
- [x] Stop showing replies at top level in feeds to make it more interesting
- [x] Fix a bug that was preventing people from sending a message
- [x] Stop sending IP addresses to bugsnag
- [x] Fix some layout bugs
2023-01-13 14:14:05 +00:00
## 0.2.7
2023-01-21 21:49:06 +00:00
- [x] Added direct messages and group chat
2023-01-16 23:12:10 +00:00
- [x] Sped up feeds by requesting less context
- [x] Sped up alerts by storing them in dexie
- [x] Fixed feeds so they don't jump around
- [x] Switched from time-based to limit-based cursors
- [x] Added batching for note context to speed things up
- [x] Fixed support for old-style reply identification
- [x] Improved reliability of event retrieval by following relay hints
- [x] Added default petnames and relays
- [x] Added support for user banners
- [x] Added recommended relay to tags
- [x] Added topics to note composition
- [x] Added a way to remove mentions from replies
- [x] Coracle now publishes user relays using kind 10001 per NIP 23
- [x] Menu now stays open on larger screens
- [x] Standardized some layout components
- [x] Added support for profile banner images
- [x] Support connection status/speed indication on relays
- [x] Add toggle to enable writing to a connected relay
- [x] Re-designed login and relay pages
- [x] Use private key login only if extension is not enabled
- [x] Add pubkey login support
- [x] Removed dexie for most things
- [x] Added support for bech32 entities
- [x] Auto-disconnect/reconnect to spare relay resources
- [x] Added automatic relay discovery
- [x] Added error tracking with bugsnag
- [x] Upgraded nostr-tools
2023-01-17 00:09:36 +00:00
- [x] Added support for NIP-05 verfication
2023-01-21 19:49:09 +00:00
- [x] Added analytics and error reporting (opt out supported)
2023-01-06 22:19:59 +00:00
2022-12-30 23:52:29 +00:00
## 0.2.6
2023-01-02 13:21:39 +00:00
- [x] Add support for at-mentions in note and reply composition
2022-12-30 23:52:29 +00:00
- [x] Improve cleanup on logout
- [x] Move add note button to be available everywhere
- [x] Fix reporting relay along with tags
2023-01-01 05:43:07 +00:00
- [x] Add support for bech32 keys
2023-01-02 12:34:04 +00:00
- [x] Add second order follows to network tab
- [x] Add favicon and social media preview image
2023-01-02 13:21:39 +00:00
- [x] Extract urls in person bios
- [x] Add follow/follower counts
2022-12-30 23:52:29 +00:00
2022-12-30 21:29:06 +00:00
## 0.2.5
- [x] Batch load context for feeds
2022-12-26 22:46:22 +00:00
## 0.2.4
- [x] Fix reactions - livequery is required in order to listen for changes
2022-12-26 21:37:47 +00:00
## 0.2.3
- [x] Fix reactions - we'll show new reactions optimistically to avoid complexity in listeners
2022-12-26 17:43:55 +00:00
## 0.2.2
- [x] Show notification for new notes rather than automatically adding them to the feed
- [x] Improve slow relay pruning by using a timeout for each relay
- [x] Re-work feed loading - go to network first and fall back to cache to ensure results that are as complete as possible
- [x] Slightly improved context fetching to reduce subscriptions
- [x] Split person feeds out into separate components
- [x] Add timeout in scroller to keep polling for new results
2022-12-26 21:12:38 +00:00
- [x] Fix fall-through on user badge click on alerts page
- [x] Fix deletion of old events, be more aggressive
2022-12-26 17:43:55 +00:00
2022-12-24 21:50:18 +00:00
## 0.2.1
- [x] Exclude people from search who have no profile data available
- [x] Speed up note retrieval by sorting first when the filter isn't restrictive
- [x] Only show a certain number of replies on popular notes, with a link at the bottom showing total replies
- [x] Refine algorithm for which relays to drop when they don't send an eose. This helps avoid the "we couldn't find this note" error message on the note detail, since we were giving up too early.
- [x] Improve url detection and shortening
2022-12-24 00:02:01 +00:00
## 0.2.0
2022-12-24 00:36:17 +00:00
- [x] Completely re-worked data synchronization layer, moving from naive just-in-time requests to background listeners, loaders, and a local copy stored in dexie. Events and tags, but not people are deleted from the database on logout, and old events are periodically purged.
- [x] Added alert badge and page.
- [x] Improved relay page. Suggestions are now taken from
- [x] Removed chat to keep scope of work smaller. Let me know if you'd like to see that come back.
- [x] Split tabs out into separate components
- [x] Removed dispatch, added cmd instead
- [x] Added image previews in addition to link previews
- [x] Fixed infinite scrolling
- [x] Removed cursor/listener abstractions
- [x] Added some default pubkeys
- [x] Wait for some, not all relays to send eose to keep things fast
- [x] General refactoring and bugfixing
