Skip to content

README.md

Latest commit

 

History

History
53 lines (40 loc) · 1.48 KB

README.md

File metadata and controls

53 lines (40 loc) · 1.48 KB

Magic Carpet

Decentralized list marketplace built on Nostr, with NIP-57 zap payments.

Quick Start

# Install dependencies
npm install
cargo install dioxus-cli

# Build Tailwind CSS and serve the website
just dx-tw-build
just dx-web

The site runs at http://localhost:8080.

Prerequisites

  • Rust (stable, edition 2024)
  • Node.js (for Tailwind CSS)
  • just (command runner)
  • dioxus-cli (cargo install dioxus-cli)

Project Structure

crates/
  carpet-ui/     # Dioxus web UI (Tailwind CSS)
  nostr-lib/     # Nostr client — relay mgmt, DCoSL lists, NIP-57 zaps
  dcosl-core/    # DCoSL protocol types and d-tag generation
  phoenixd-lib/  # PhoenixD Lightning HTTP client (used by nostr-lib for zaps)

Commands

Command Description
just dx-web Serve website (dev mode, hot reload)
just dx-desktop Serve as desktop app
just dx-tw Watch & rebuild Tailwind CSS
just dx-tw-build Build Tailwind CSS once
just check cargo check workspace
just test Run all tests
just clippy Lint workspace

Tech Stack

  • Dioxus 0.7 — full-stack Rust web framework
  • Tailwind CSS 4 — styling
  • nostr-sdk 0.44 — Nostr protocol
  • DCoSL — Decentralized Curated Sorted Lists protocol