nostr
/
coracle
mirror of https://github.com/coracle-social/coracle.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
coracle/README.md

1.8 KiB
Raw Blame History

What is this?

Coracle is a web client for the Nostr protocol focused on pushing the boundaries of what's unique about nostr, including relay selection and management, web-of-trust based moderation and content recommendations, and privacy protection. 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

  • Threads/social
  • Profile search using NIP-50
  • Login via extension
  • Profile sharing via QR codes
  • NIP 05 verification
  • Bech32 entity search
  • Notifications
  • Chat and direct messages
  • Note composition with mentions and topics
  • Profile pages, follow/unfollow
  • Thread and person muting, collapse thread
  • Smart relay selection and display
  • Invoice, quote, mention, link, image, and video rendering
  • Installable as a progressive web app
  • Integrated media uploads
  • Lightning zaps
  • Feeds customizable by person, relay, and topic using NIP-51
  • AUTH (NIP-42) support for paid relays
  • Multiplextr support for reducing bandwidth
  • Profile and note metadata
  • White-labeling support
  • Exportable copy of all user events
  • Reporting and basic distributed moderation
  • Content and person recommendations

You can find a more complete changelog here.

Run Coracle locally:

  • Clone the project repository: git clone https://github.com/coracle-social/coracle.git
  • Navigate to the project directory: cd coracle
  • Install dependencies: yarn
  • Customize configuration in .env (optional)
  • Start the development server: yarn dev