nostr/coracle
1
0
Fork 0
mirror of https://github.com/coracle-social/coracle.git synced 2024-09-15 17:53:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
A Nostr client that makes relays a first-class concept
612 Commits 5 Branches 55 Tags 28 MiB
Svelte 69.2%
TypeScript 26.5%
HTML 2.3%
JavaScript 1.3%
CSS 0.5%
Other 0.2%
a83a5d25be
Go to file
Jonathan Staab a83a5d25be Fix url regex
2023-06-09 06:18:13 -07:00
.husky Fix formatting check 2023-03-08 08:13:53 -06:00
public Add well-known directory to public 2023-04-13 08:39:20 -05:00
src Fix url regex 2023-06-09 06:18:13 -07:00
.ackrc Fix onboarding, move some stuff to env vars, fix cursor 2023-04-26 10:12:32 -05:00
.env Simplify theme config 2023-04-27 12:27:20 -05:00
.eslintrc.cjs Small contenteditable fix, try using since on feeds 2023-03-25 09:33:59 -05:00
.fdignore Add capacitorjs 2023-04-24 20:19:22 -05:00
.gitignore Add capacitorjs 2023-04-24 20:19:22 -05:00
.prettierrc Add prettier 2023-03-08 08:02:18 -06:00
capacitor.config.ts Add capacitorjs 2023-04-24 20:19:22 -05:00
CHANGELOG.md Add tags to notes by parsing content, add note delete button, add mentions to quotes, increase routes table and change sort order to hopefully get better relay hints, upgrade mentions from square bracket notation to bech32 embeds 2023-06-07 05:55:12 -07:00
CNAME Adjust urls 2023-04-10 09:05:16 -05:00
index.html Adjust urls 2023-04-10 09:05:16 -05:00
jsconfig.json First commit 2022-11-22 17:28:33 -08:00
LICENSE Switch license back to MIT 2023-03-16 09:09:23 -07:00
package-lock.json Attempt to fix contenteditable dropping breaks 2023-06-05 05:55:07 -07:00
package.json Fix onboarding, move some stuff to env vars, fix cursor 2023-04-26 10:12:32 -05:00
postcss.config.cjs First commit 2022-11-22 17:28:33 -08:00
README.md Fix lists selector 2023-04-27 16:44:55 -05:00
ROADMAP.md fix relay hint for mentions 2023-06-07 18:32:31 -07:00
tailwind.config.cjs Add light theme 2023-03-16 14:03:42 -05:00
tsconfig.json Add typescript 2023-02-03 17:01:29 -06:00
vite.config.js Add protocol handlers to manifest 2023-05-21 14:24:46 -07:00

README.md

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.

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
  • Profile sharing via QR codes
  • NIP 05 verification
  • Bech32 entity search
  • Notifications
  • Chat and direct messages
  • Note composition with mentions and topics
  • Profile pages, follow/unfollow
  • Thread and person muting, collapse thread
  • Smart relay selection and display
  • Invoice, quote, mention, link, image, and video rendering
  • Installable as a progressive web app
  • Integrated media uploads
  • Lightning zaps
  • 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
  • Exportable copy of all user events
  • Reporting and basic distributed moderation
  • Content and person recommendations

You can find a more complete changelog here.

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