nostr/coracle
1
0
Fork 0
mirror of https://github.com/coracle-social/coracle.git synced 2024-09-29 00:10:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
A Nostr client that makes relays a first-class concept
1,331 Commits 5 Branches 56 Tags 31 MiB
Svelte 71.4%
TypeScript 23.8%
HTML 2.5%
JavaScript 1.5%
CSS 0.6%
Other 0.2%
932a02a27e
Go to file
Jon Staab 932a02a27e Update readme
2024-01-31 09:34:32 -08: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 Add listings 2023-12-05 10:44:12 -08:00
src Fix withUnwrappedEvent to call the callback on cache hit 2024-01-31 08:52:58 -08:00
.ackrc Move loadPeople to PubkeyLoader 2023-07-11 13:47:28 -07:00
.env Clean up read receipts for notifications 2024-01-29 14:09:39 -08:00
.eslintrc.cjs Fix some navigation bugs 2024-01-02 08:43:01 -08:00
.fdignore Add capacitorjs 2023-04-24 20:19:22 -05:00
.gitignore gitignore sandbox.sql 2024-01-05 13:02:50 -08:00
.nvmrc Add support for kind 30023 2023-06-19 05:48:55 -07:00
.prettierrc Upgrade deps 2023-12-01 11:51:48 -08:00
capacitor.config.ts Add capacitorjs 2023-04-24 20:19:22 -05:00
CHANGELOG.md Fix withUnwrappedEvent to call the callback on cache hit 2024-01-31 08:52:58 -08: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
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
LICENSE Switch license back to MIT 2023-03-16 09:09:23 -07:00
package.json Bump paravel 2024-01-09 11:01:50 -08:00
postcss.config.cjs First commit 2022-11-22 17:28:33 -08:00
README.md Update readme 2024-01-31 09:34:32 -08:00
tailwind.config.cjs Add support for Tailwind dark: prefix 2024-01-16 22:58:01 +01:00
tsconfig.json Upgrade deps 2023-12-01 11:51:48 -08:00
vite.config.js Add protocol handlers to manifest 2023-05-21 14:24:46 -07:00
yarn.lock Bump paravel 2024-01-09 11:01:50 -08: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
  • NIP 99 classifieds
  • NIP 52 calendar events
  • NIP 87 closed groups
  • NIP 72 communities
  • NIP 89 client tag support
  • NIP 32 labeling and collections
  • Private group calendars and listings
  • Cross-posting between communities and main feed
  • 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 NIP 96
  • Lightning zaps and reactions
  • Feeds customizable by person, relay, and topic using NIP-51
  • AUTH (NIP-42) support for closed relays
  • Multiplextr support for reducing bandwidth
  • Profile and note metadata
  • White-labeling support
  • NIP 51 person lists
  • Exports/imports of user events
  • User profile editing
  • NIP XX encrypted read receipts for notifications
  • Topic and relay feeds
  • Onboarding workflow
  • Multi-account support
  • Notifications view

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