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.
Coracle is currently in _alpha_ - expect bugs, slow loading times, and rough edges.
2022-11-24 19:47:03 +00:00
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-04 00:42:10 +00:00
- [ ] Persist and load relay list
2023-01-01 05:43:07 +00:00
- [ ] Add followers/follows lists on profile page
2022-12-15 18:31:47 +00:00
- [ ] Image uploads
2023-01-05 12:42:20 +00:00
- [ ] Server discovery and relay publishing https://github.com/nostr-protocol/nips/pull/32/files
2022-12-17 20:30:18 +00:00
- [ ] Support invoices https://twitter.com/jb55/status/1604131336247476224
2022-12-23 19:59:40 +00:00
- [ ] NIP 05
2022-12-30 21:29:06 +00:00
- [ ] Lightning tips
2023-01-05 12:42:20 +00:00
- [ ] Direct messages https://github.com/nbd-wtf/nostr-tools/blob/master/nip04.ts
2022-12-30 21:29:06 +00:00
- [ ] Rooms/groups
2023-01-04 00:42:10 +00:00
- [ ] Custom feeds
2023-01-05 12:42:20 +00:00
- [ ] Render and auto-link bech32 entities
- https://github.com/nostr-protocol/nips/blob/master/19.md
- https://github.com/nbd-wtf/nostr-tools/blob/master/nip19.ts
- [ ] Support key delegation
- https://github.com/nbd-wtf/nostr-tools/blob/master/nip26.ts
2023-01-07 17:48:01 +00:00
- [ ] Add relay selector when publishing a note
- [ ] Add keyword mutes
2022-12-15 18:31:47 +00:00
# Bugs
2023-01-04 04:46:06 +00:00
- [ ] Add CSP
2023-01-03 12:19:35 +00:00
- [ ] Reduce reflow on feeds from new stuff coming in
2022-12-30 21:29:06 +00:00
- [ ] Follow fiatjaf's vision of clients being smart and connecting to recommended relays to fetch content
2022-12-15 18:31:47 +00:00
- [ ] Stack views so scroll position isn't lost on navigation
2022-12-30 21:29:06 +00:00
- [ ] Add notification for slow relays, suggest relays based on network
2022-12-24 21:50:18 +00:00
- [ ] Separating events table into notes/reactions/etc would effectively give us a second index on kind.
2022-12-16 17:45:58 +00:00
2022-12-24 00:02:01 +00:00
# Changelog
2023-01-06 22:19:59 +00:00
## Current
2023-01-07 17:48:01 +00:00
- [x] Upgrade nostr-tools
2023-01-10 14:03:18 +00:00
- [x] Publish user relays using nip 23
- [x] Use user relays for feeds
2023-01-07 17:48:01 +00:00
- [ ] Publish to user relays + target relays:
- If a reply or reaction, publish to the parent event's best relay, which is:
- e tag relay
- p tag relay
- or pubkey's recommended relays
2023-01-10 14:03:18 +00:00
- [ ] Add correct recommended relay to tags
2023-01-07 17:48:01 +00:00
- [ ] Close connections that haven't been used in a while
- [ ] Support some read/write config on relays page
- [ ] Get real home relays for default pubkeys
- [ ] Add settings storage
- [ ] Warn that everything will be cleared on logout
- [ ] Clear dexie on page load, we don't need any persistence other than people/relays
- [ ] Clean up login page to prefer extension, make private key entry "advanced"
- [ ] Do I need to implement re-connecting now?
- [ ] handle localstorage limits https://stackoverflow.com/questions/2989284/what-is-the-max-size-of-localstorage-values
2023-01-10 13:09:44 +00:00
- [ ] Clean up nostr utils
- [ ] Improve login UX for bootstrap delay. Nostr facts?
- [ ] Use bech32 entities
- [ ] Revisit pagination. Use bigger timedelta + limit, set earliest seen timestamp when paginating? Handle no results on page.
- [ ] We often get the root as the reply, figure out why that is
- [ ] Alerts still aren't great. Maybe lazy load? We delete old events, so context will disappear and notes will become empty.
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
