coracle/README.md
2023-03-03 10:44:58 -06:00

1.7 KiB

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

  • Threads/social
  • Profile search
  • 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
  • Follow and follower lists
  • Profile pages, follow/unfollow, mute
  • Persistent color-coded relay list
  • Smart relay selection and display
  • Connection quality information
  • Invoice, bech32 entity, mention, link, image, and video rendering
  • Installable as a progressive web app
  • Media uploads
  • Lightning zaps
  • Feeds customizable by person, relay, and topic
  • Keyword mutes
  • Exportable copy of all user events
  • Reporting and basic distributed moderation
  • Content and person recommendations
  • Profile and content search

You can find a more complete changelog here.

Run Coracle locally:

  • Clone the project repository: git clone https://github.com/staab/coracle.git
  • Navitage to the project directory: cd coracle
  • Install dependencies: npm install
  • Add an env file from the template: cp env.template env.local
  • Start the development server: npm run dev