mirror of
https://github.com/coracle-social/coracle.git
synced 2024-10-06 11:43:30 +00:00
44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
# 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](https://coracle.social).
|
|
|
|
[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.
|
|
|
|
If you like Coracle and want to support its development, you can donate sats via [Geyser](https://geyser.fund/project/coracle).
|
|
|
|
# Features
|
|
|
|
- [x] Threads/social
|
|
- [x] Profile search using NIP-50
|
|
- [x] Login via extension
|
|
- [x] Profile sharing via QR codes
|
|
- [x] NIP 05 verification
|
|
- [x] Bech32 entity search
|
|
- [x] Notifications
|
|
- [x] Chat and direct messages
|
|
- [x] Note composition with mentions and topics
|
|
- [x] Profile pages, follow/unfollow
|
|
- [x] Thread and person muting, collapse thread
|
|
- [x] Smart relay selection and display
|
|
- [x] Invoice, quote, mention, link, image, and video rendering
|
|
- [x] Installable as a progressive web app
|
|
- [x] Integrated media uploads
|
|
- [x] Lightning zaps
|
|
- [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
|
|
- [ ] Exportable copy of all user events
|
|
- [ ] Reporting and basic distributed moderation
|
|
- [ ] Content and person recommendations
|
|
|
|
You can find a more complete changelog [here](./ROADMAP.md).
|
|
|
|
# Run Coracle locally:
|
|
|
|
- Clone the project repository: `git clone https://github.com/coracle-social/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`
|