A Nostr client that makes relays a first-class concept
Go to file
Jonathan Staab 1ada6a03fa Only format/check staged files 2023-03-10 10:38:41 -06:00
.husky Fix formatting check 2023-03-08 08:13:53 -06:00
public PWA-ify 2023-02-27 16:20:23 -06:00
src Add maintenance warning 2023-03-10 10:35:49 -06:00
.ackrc Improve channel management and chunked retrieval of events 2022-11-29 10:21:51 -08:00
.env.local Add debug route 2023-02-13 17:56:03 -06:00
.env.production Remove SHOW_DEBUG_ROUTES from production env 2023-02-13 18:13:55 -06:00
.eslintrc.cjs Add prettier 2023-03-08 08:02:18 -06:00
.fdignore First commit 2022-11-22 17:28:33 -08:00
.gitignore Add support for QR codes 2023-02-11 14:59:09 -06:00
.prettierrc Add prettier 2023-03-08 08:02:18 -06:00
CHANGELOG.md Add mutes 2023-03-09 11:04:36 -06:00
CNAME Add CNAME file 2022-11-26 21:47:56 -08:00
LICENSE Update License 2023-03-06 12:07:31 -08:00
README.md Add hashed pubkey to usage data 2023-03-03 10:44:58 -06:00
ROADMAP.md Add maintenance warning 2023-03-10 10:35:49 -06:00
env.template Update install instructions 2023-03-03 09:26:56 -06:00
index.html Add prettier 2023-03-08 08:02:18 -06:00
jsconfig.json First commit 2022-11-22 17:28:33 -08:00
package-lock.json Add prettier 2023-03-08 08:02:18 -06:00
package.json Only format/check staged files 2023-03-10 10:38:41 -06:00
postcss.config.cjs First commit 2022-11-22 17:28:33 -08:00
tailwind.config.cjs Make "show new notes" button fixed position 2023-03-08 15:50:05 -06:00
tsconfig.json Add typescript 2023-02-03 17:01:29 -06:00
vite.config.js PWA-ify 2023-02-27 16:20:23 -06:00

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

  • 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