2022-12-15 18:31:47 +00:00
# What is this?
2022-11-24 19:47:03 +00:00
2023-07-26 16:45:53 +00:00
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 ](https://coracle.social ).
2022-12-15 18:31:47 +00:00
2023-03-29 15:17:37 +00:00
[Dufflepud ](https://github.com/coracle-social/dufflepud ) is a companion server which you can self-host. It helps Coracle with things like link previews and image uploads.
2022-12-15 18:31:47 +00:00
2022-12-24 00:02:01 +00:00
If you like Coracle and want to support its development, you can donate sats via [Geyser ](https://geyser.fund/project/coracle ).
2022-12-15 18:31:47 +00:00
# Features
2022-11-24 19:47:03 +00:00
2022-11-27 03:34:28 +00:00
- [x] Threads/social
2023-04-20 15:19:22 +00:00
- [x] Profile search using NIP-50
2023-09-27 16:59:22 +00:00
- [x] Login via extension, nsecbunker, and pubkey
2023-02-15 16:27:49 +00:00
- [x] Profile sharing via QR codes
- [x] NIP 05 verification
2023-09-27 16:59:22 +00:00
- [x] NIP 65 relay selection and NIP 32 relay reviews
- [x] NIP 89 app recommendations
- [x] NIP 32 labeling and recommendations
- [x] Bech32 entity search and scan
- [x] Mention, reply, and reaction notifications
- [x] Direct messages - NIP 04 and NIP 24
2023-02-15 16:27:49 +00:00
- [x] Note composition with mentions and topics
2023-09-27 16:59:22 +00:00
- [x] Content warnings, mute, and keyword mute
- [x] Profile pages, follow/unfollow, follow/follower count
- [x] Thread muting, collapse thread
2023-04-20 15:19:22 +00:00
- [x] Invoice, quote, mention, link, image, and video rendering
2023-03-03 16:44:58 +00:00
- [x] Installable as a progressive web app
2023-09-27 16:59:22 +00:00
- [x] Integrated media uploads via nostr.build
- [x] Lightning zaps and reactions
2023-04-20 15:19:22 +00:00
- [x] Feeds customizable by person, relay, and topic using NIP-51
- [x] AUTH (NIP-42) support for paid relays
- [x] Multiplextr support for reducing bandwidth
- [x] Profile and note metadata
2023-04-27 18:35:24 +00:00
- [x] White-labeling support
2023-09-27 16:59:22 +00:00
- [x] NIP 51 person lists
- [x] Exportable copy of all user events
2023-11-22 21:04:49 +00:00
- [x] NIP96 - HTTP File Storage Integration
2023-02-15 16:27:49 +00:00
- [ ] Reporting and basic distributed moderation
- [ ] Content and person recommendations
2023-09-27 16:59:22 +00:00
- [ ] Private groups including administration, moderation, and membership
- [ ] Cross-posting between groups and public nostr
- [ ] Public and private calendar events
- [ ] Public and private marketplaces
2023-02-15 16:27:49 +00:00
2023-08-03 18:09:50 +00:00
You can find a more complete changelog [here ](./CHANGELOG.md ).
2023-03-02 20:37:08 +00:00
# Run Coracle locally:
2023-03-29 15:17:37 +00:00
- Clone the project repository: `git clone https://github.com/coracle-social/coracle.git`
2023-08-03 18:09:50 +00:00
- Navigate to the project directory: `cd coracle`
- Install dependencies: `yarn`
2023-08-28 16:10:47 +00:00
- Customize configuration in `.env` (optional)
2023-08-03 18:09:50 +00:00
- Start the development server: `yarn dev`
