A Nostr client that makes relays a first-class concept
Go to file
Jonathan Staab bc88d341d4 Add cypress tests 2023-10-12 16:23:32 -07:00
.husky Fix formatting check 2023-03-08 08:13:53 -06:00
cypress Add cypress tests 2023-10-12 16:23:32 -07:00
public switch to Lato 2023-10-03 09:19:54 -07:00
src Add cypress tests 2023-10-12 16:23:32 -07:00
.ackrc Move loadPeople to PubkeyLoader 2023-07-11 13:47:28 -07:00
.env Manage bidirectional encode/decode for routes more tidily 2023-10-11 09:42:07 -07:00
.eslintrc.cjs Remove old user stuff 2023-09-11 16:48:17 -07:00
.fdignore Add capacitorjs 2023-04-24 20:19:22 -05:00
.gitignore Improve long form 2023-08-17 17:01:37 -07:00
.nvmrc Add support for kind 30023 2023-06-19 05:48:55 -07:00
.prettierrc Add prettier 2023-03-08 08:02:18 -06:00
CHANGELOG.md Allow showing hidden replies 2023-10-12 13:51:30 -07:00
CNAME Adjust urls 2023-04-10 09:05:16 -05:00
CONTRIBUTING.md Remove nip28 chat 2023-09-27 09:59:22 -07:00
LICENSE Switch license back to MIT 2023-03-16 09:09:23 -07:00
README.md Remove nip28 chat 2023-09-27 09:59:22 -07:00
capacitor.config.ts Add capacitorjs 2023-04-24 20:19:22 -05:00
cypress.config.ts Add cypress tests 2023-10-12 16:23:32 -07:00
index.html Just some small fixes 2023-07-08 09:08:45 -07:00
jsconfig.json First commit 2022-11-22 17:28:33 -08:00
package.json Add cypress tests 2023-10-12 16:23:32 -07:00
postcss.config.cjs First commit 2022-11-22 17:28:33 -08:00
tailwind.config.cjs Fix person detail layout on small screens 2023-08-02 12:08:01 -07:00
tsconfig.json Add cypress tests 2023-10-12 16:23:32 -07:00
vite.config.js Add protocol handlers to manifest 2023-05-21 14:24:46 -07:00
yarn.lock Add cypress tests 2023-10-12 16:23:32 -07:00

README.md

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, nsecbunker, and pubkey
  • Profile sharing via QR codes
  • NIP 05 verification
  • NIP 65 relay selection and NIP 32 relay reviews
  • NIP 89 app recommendations
  • NIP 32 labeling and recommendations
  • Bech32 entity search and scan
  • Mention, reply, and reaction notifications
  • Direct messages - NIP 04 and NIP 24
  • Note composition with mentions and topics
  • Content warnings, mute, and keyword mute
  • Profile pages, follow/unfollow, follow/follower count
  • Thread muting, collapse thread
  • Invoice, quote, mention, link, image, and video rendering
  • Installable as a progressive web app
  • Integrated media uploads via nostr.build
  • Lightning zaps and reactions
  • 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
  • NIP 51 person lists
  • Exportable copy of all user events
  • Reporting and basic distributed moderation
  • Content and person recommendations
  • Private groups including administration, moderation, and membership
  • Cross-posting between groups and public nostr
  • Public and private calendar events
  • Public and private marketplaces

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