Skip to content

miragelabs-dev/xora

Repository files navigation

πŸš€ Decentralized Social Network

Welcome to our Decentralized Twitter Clone built with Chopin Framework and Celestia! 🌐✨ This project aims to create a censorship-resistant, secure, and scalable social network.

Screenshot 2025-03-01 at 01 05 00 Screenshot 2025-03-01 at 01 05 33

πŸ† Why This Project?

Existing social networks are either centralized (X) or don't fully inherit blockchain security (Farcaster). Our solution leverages Chopin Framework + Celestia to ensure true decentralization while remaining scalable.

βš™οΈ Tech Stack

  • πŸ”Ή Chopin Framework πŸ› οΈ (Modular blockchain infra)
  • πŸ”Ή Celestia 🌐 (Data availability & security)
  • πŸ”Ή Next.js ⚑ (Frontend framework)
  • πŸ”Ή PostgreSQL πŸ—„οΈ (Database)
  • πŸ”Ή Drizzle ORM 🎯 (TypeScript ORM)
  • πŸ”Ή Cloudinary ☁️ (Image storage)
  • πŸ”Ή TailwindCSS 🎨 (Styling)
  • πŸ”Ή Shadcn/UI 🎯 (UI Components)
  • πŸ”Ή tRPC 🎯 (API layer)

πŸš€ Getting Started

Prerequisites

  • Node.js 18+
  • PNPM package manager
  • Chopin CLI
  • Docker (for local development)

Installation

# Copy .env.example to .env and set the environment variables
cp .env.example .env

# Database setup
docker compose up -d

# Install dependencies
pnpm install

# Migrate database
pnpm db:push

# Start Chopin node & Development server
npx chopd

πŸ“‹ TODO List

Core Features

  • Standard Twitter clone features

    • Notification system
    • Bookmarks system
    • Messages system
    • Comments and replies system
    • Retweet functionality
    • Follow/unfollow users
    • Profile management
    • Profile picture upload
    • Profile banner upload
    • Update profile information
    • Mention users in posts
    • Hashtag search
  • NFT Features

    • Create a NFT collection
    • Edit a NFT collection
    • View a NFT collection
    • Mint a NFT
  • Crypto Bot Features

    • Auto ticker for coins mentioned in posts
    • Direct trading links to Binance
    • Follow/unfollow crypto bots
    • Price change indicators

Future Planning

  • Cross-chain Trading
  • Embedded Web3 Apps
  • Social Hook Stack Framework

CI/CD Workflow

This project uses GitHub Actions for continuous integration. The workflow includes:

  • Trigger: Runs on push to main branch and pull requests
  • Environment: Ubuntu latest with Node.js 20
  • Steps:
    1. Code checkout
    2. Node.js and pnpm setup
    3. Dependencies installation
    4. Linting check
    5. Build verification
    6. Security audit

You can view the workflow configuration in .github/workflows/code-check.yml.

πŸ“œ License

MIT License. Use, modify, and contribute freely. πŸ“

πŸ‘€ Stay tuned for updates & feel free to share your thoughts! πŸš€

About

πŸ† Celestia Mammothon 2025 Finalist

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages