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.

Dufflepud is a companion server which you can self-host. It helps Coracle with things like link previews and image uploads.

If you like Coracle and want to support its development, you can donate sats via Geyser.

Features

• Chat
• Threads/social
• Search
• Notifications
• Link previews
• Add notes, follows, likes tab to profile
• Mentions
• Persist and load relay list
• NIP 05
• Direct messages using NIP 04
• Deploy coracle relay, set better defaults
• Image uploads
  • Use dufflepud. Default will charge via lightning and have a tos, others can self-host and skip that.
  • Add banner field to profile
• Release to android with https://svelte-native.technology/docs
• Support invoices https://twitter.com/jb55/status/1604131336247476224
• Lightning tips
• Add followers/follows lists on profile page
• Rooms/groups
• Custom feeds
• Support key delegation
  • https://github.com/nbd-wtf/nostr-tools/blob/master/nip26.ts
• Add relay selector when publishing a note
• Add keyword mutes
• Add no-relay gossip
  • Capture certain events in a local db
  • File import/export from db, NFC transfer
  • Save user notes to db
• Add settings storage on nostr, maybe use kind 0?
• Stack views so scroll position isn't lost on navigation
• Attachments (a tag w/content type and url)
• Add Labs tab with cards for non-standard features
  • Time travel - see events as of a date/time
• 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

Bugs

• Everything waits for even the slowest relay to connect before returning events
• Alerts are not showing likes, just generally screwy. Maybe because I threadify before adding to the db?
• Change network tab to list relays the user is connected to
• Sync mentions box and in-reply mentions
• Add petnames for channels
  • Add notifications for chat messages

Changelog

0.2.8

• Stop showing replies at top level in feeds to make it more interesting
• Fix a bug that was preventing people from sending a message
• Stop sending IP addresses to bugsnag
• Fix some layout bugs

0.2.7

• Added direct messages and group chat
• Sped up feeds by requesting less context
• Sped up alerts by storing them in dexie
• Fixed feeds so they don't jump around
• Switched from time-based to limit-based cursors
• Added batching for note context to speed things up
• Fixed support for old-style reply identification
• Improved reliability of event retrieval by following relay hints
• Added default petnames and relays
• Added support for user banners
• Added recommended relay to tags
• Added topics to note composition
• Added a way to remove mentions from replies
• Coracle now publishes user relays using kind 10001 per NIP 23
• Menu now stays open on larger screens
• Standardized some layout components
• Added support for profile banner images
• Support connection status/speed indication on relays
• Add toggle to enable writing to a connected relay
• Re-designed login and relay pages
• Use private key login only if extension is not enabled
• Add pubkey login support
• Removed dexie for most things
• Added support for bech32 entities
• Auto-disconnect/reconnect to spare relay resources
• Added automatic relay discovery
• Added error tracking with bugsnag
• Upgraded nostr-tools
• Added support for NIP-05 verfication
• Added analytics and error reporting (opt out supported)

0.2.6

• Add support for at-mentions in note and reply composition
• Improve cleanup on logout
• Move add note button to be available everywhere
• Fix reporting relay along with tags
• Add support for bech32 keys
• Add second order follows to network tab
• Add favicon and social media preview image
• Extract urls in person bios
• Add follow/follower counts

0.2.5

• Batch load context for feeds

0.2.4

• Fix reactions - livequery is required in order to listen for changes

0.2.3

• Fix reactions - we'll show new reactions optimistically to avoid complexity in listeners

0.2.2

• Show notification for new notes rather than automatically adding them to the feed
• Improve slow relay pruning by using a timeout for each relay
• Re-work feed loading - go to network first and fall back to cache to ensure results that are as complete as possible
• Slightly improved context fetching to reduce subscriptions
• Split person feeds out into separate components
• Add timeout in scroller to keep polling for new results
• Fix fall-through on user badge click on alerts page
• Fix deletion of old events, be more aggressive

0.2.1

• Exclude people from search who have no profile data available
• Speed up note retrieval by sorting first when the filter isn't restrictive
• Only show a certain number of replies on popular notes, with a link at the bottom showing total replies
• 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.
• Improve url detection and shortening

0.2.0

• 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.
• Added alert badge and page.
• Improved relay page. Suggestions are now taken from
• Removed chat to keep scope of work smaller. Let me know if you'd like to see that come back.
• Split tabs out into separate components
• Removed dispatch, added cmd instead
• Added image previews in addition to link previews
• Fixed infinite scrolling
• Removed cursor/listener abstractions
• Added some default pubkeys
• Wait for some, not all relays to send eose to keep things fast
• General refactoring and bugfixing