nostr/coracle
1
0
Fork 0
mirror of https://github.com/coracle-social/coracle.git synced 2024-09-29 08:21:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
A Nostr client that makes relays a first-class concept
1,473 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%
2041ec6a7d
Go to file
Jon Staab 2041ec6a7d Various relay selection changes
2024-03-12 08:19:16 -07:00
.husky
cypress
public Rework onboarding, continue working on nostr connect 2024-02-08 19:07:56 -08:00
src Various relay selection changes 2024-03-12 08:19:16 -07:00
.ackrc
.env Fall back to default relays more often, normalize relay urls 2024-03-12 08:19:16 -07:00
.eslintrc.cjs
.fdignore
.gitignore gitignore sandbox.sql 2024-01-05 13:02:50 -08:00
.nvmrc
.prettierrc
capacitor.config.ts
CHANGELOG.md Improve invite creation 2024-03-12 08:19:16 -07:00
CNAME
CONTRIBUTING.md
cypress.config.ts
Dockerfile add a very basic docker image (#299) 2024-03-07 11:22:51 -08:00
index.html Add CSP 2024-02-22 16:26:45 -08:00
LICENSE
package.json Bump paravel 2024-03-12 08:19:16 -07:00
postcss.config.cjs
README.md Update readme 2024-01-31 09:34:32 -08:00
tailwind.config.cjs Submit claim as part of auth 2024-02-23 10:41:44 -08:00
tsconfig.json
vite.config.js
yarn.lock Bump paravel 2024-03-12 08:19:16 -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
  • 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