coracle/README.md

# What is this?

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).

[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.

If you like Coracle and want to support its development, you can donate sats via [Geyser](https://geyser.fund/project/coracle).

# Features

- [x] Chat
- [x] Threads/social
- [x] Search
- [x] Notifications
- [x] Link previews
- [x] Add notes, follows, likes tab to profile
- [x] Mentions
- [ ] Add followers/follows lists on profile page
- [ ] Image uploads
- [ ] Server discovery and relay publishing - https://github.com/nostr-protocol/nips/pull/32/files
- [ ] Support invoices https://twitter.com/jb55/status/1604131336247476224
- [ ] NIP 05
- [ ] Lightning tips
- [ ] Direct messages
- [ ] Rooms/groups

# Bugs

- [ ] Reload user details when loading on visiting a user's page for the first time
- [ ] Fix nuking follow list on multiple devices. Aggressive refresh? Dufflepud caching?
- [ ] Follow fiatjaf's vision of clients being smart and connecting to recommended relays to fetch content
- [ ] Add alerts for replies to posts the user liked
- [ ] Stack views so scroll position isn't lost on navigation
- [ ] Add notification for slow relays, suggest relays based on network
- [ ] Separating events table into notes/reactions/etc would effectively give us a second index on kind.

# Changelog

## 0.2.6

- [x] Add support for at-mentions
- [x] Improve cleanup on logout
- [x] Move add note button to be available everywhere
- [x] Fix reporting relay along with tags
- [x] Add support for bech32 keys
- [ ] Add favicon and social media preview image

## 0.2.5

- [x] Batch load context for feeds

## 0.2.4

- [x] Fix reactions - livequery is required in order to listen for changes

## 0.2.3

- [x] Fix reactions - we'll show new reactions optimistically to avoid complexity in listeners

## 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
- [x] Fix fall-through on user badge click on alerts page
- [x] Fix deletion of old events, be more aggressive

## 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

## 0.2.0

- [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
Update readme 2022-12-15 18:31:47 +00:00			`# What is this?`
Add chat 2022-11-24 19:47:03 +00:00
Fix alerts 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).`
Update readme 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.`
Add chat 2022-11-24 19:47:03 +00:00
Fix alerts 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).`

Update readme 2022-12-15 18:31:47 +00:00			`# Features`
Add chat 2022-11-24 19:47:03 +00:00
Add support for custom relay urls 2022-11-27 03:34:28 +00:00			`- [x] Chat`
			`- [x] Threads/social`
Add link previews 2022-12-03 20:26:09 +00:00			`- [x] Search`
Move some stuff around 2022-12-15 13:55:12 +00:00			`- [x] Notifications`
Add sourcemaps 2022-12-06 05:46:40 +00:00			`- [x] Link previews`
Fix user detail tabs 2022-12-14 06:01:26 +00:00			`- [x] Add notes, follows, likes tab to profile`
Add mentions when composing a note or reply, tweak some feed timings 2022-12-30 23:52:29 +00:00			`- [x] Mentions`
Add support for bech32 keys 2023-01-01 05:43:07 +00:00			`- [ ] Add followers/follows lists on profile page`
Update readme 2022-12-15 18:31:47 +00:00			`- [ ] Image uploads`
Add link previews 2022-12-03 20:26:09 +00:00			`- [ ] Server discovery and relay publishing - https://github.com/nostr-protocol/nips/pull/32/files`
Working on scrolling stuff 2022-12-17 20:30:18 +00:00			`- [ ] Support invoices https://twitter.com/jb55/status/1604131336247476224`
Fix alerts 2022-12-23 19:59:40 +00:00			`- [ ] NIP 05`
Batch load context on feeds. This makes loading faster, and provides more context 2022-12-30 21:29:06 +00:00			`- [ ] Lightning tips`
			`- [ ] Direct messages`
			`- [ ] Rooms/groups`
Update readme 2022-12-15 18:31:47 +00:00
			`# Bugs`

Add support for bech32 keys 2023-01-01 05:43:07 +00:00			`- [ ] Reload user details when loading on visiting a user's page for the first time`
			`- [ ] Fix nuking follow list on multiple devices. Aggressive refresh? Dufflepud caching?`
Batch load context on feeds. This makes loading faster, and provides more context 2022-12-30 21:29:06 +00:00			`- [ ] Follow fiatjaf's vision of clients being smart and connecting to recommended relays to fetch content`
Update readme 2022-12-15 18:31:47 +00:00			`- [ ] Add alerts for replies to posts the user liked`
			`- [ ] Stack views so scroll position isn't lost on navigation`
Batch load context on feeds. This makes loading faster, and provides more context 2022-12-30 21:29:06 +00:00			`- [ ] Add notification for slow relays, suggest relays based on network`
Improve query speed when loading from dexie by sorting first 2022-12-24 21:50:18 +00:00			`- [ ] Separating events table into notes/reactions/etc would effectively give us a second index on kind.`
refactor everything with dexie 2022-12-16 17:45:58 +00:00
Fix alerts 2022-12-24 00:02:01 +00:00			`# Changelog`

Add mentions when composing a note or reply, tweak some feed timings 2022-12-30 23:52:29 +00:00			`## 0.2.6`

			`- [x] Add support for at-mentions`
			`- [x] Improve cleanup on logout`
			`- [x] Move add note button to be available everywhere`
			`- [x] Fix reporting relay along with tags`
Add support for bech32 keys 2023-01-01 05:43:07 +00:00			`- [x] Add support for bech32 keys`
			`- [ ] Add favicon and social media preview image`
Add mentions when composing a note or reply, tweak some feed timings 2022-12-30 23:52:29 +00:00
Batch load context on feeds. This makes loading faster, and provides more context 2022-12-30 21:29:06 +00:00			`## 0.2.5`

			`- [x] Batch load context for feeds`

Fix reactivity of notes in feeds by using livequery 2022-12-26 22:46:22 +00:00			`## 0.2.4`

			`- [x] Fix reactions - livequery is required in order to listen for changes`

Update changelog 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`

Switch from cache-first to cache-last by always attempting to retrieve messages from the network with an aggressive timeout. 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`
Update readme 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`
Switch from cache-first to cache-last by always attempting to retrieve messages from the network with an aggressive timeout. 2022-12-26 17:43:55 +00:00
Improve query speed when loading from dexie by sorting first 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`

Fix alerts 2022-12-24 00:02:01 +00:00			`## 0.2.0`

Add changelog, wait for only some relays to eose 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`