Skip to content

README.md

Latest commit

 

History

History
141 lines (117 loc) · 3.32 KB

README.md

File metadata and controls

141 lines (117 loc) · 3.32 KB

🌟 StellarAid

A blockchain-based crowdfunding platform built on the Stellar Network for transparent, borderless, and secure fundraising.

StellarAid enables project creators to raise funds in XLM or any Stellar-based asset (USDC, NGNT, custom tokens), while donors can contribute with full on-chain transparency.

🚀 SEO & Performance Optimizations

This application is optimized for search engines and social sharing:

Meta Tags & Social Media

  • ✅ Dynamic Open Graph tags for all pages
  • ✅ Twitter Card meta tags
  • ✅ Structured data (JSON-LD) for organization and projects
  • ✅ Proper meta descriptions and titles

Technical SEO

  • ✅ Sitemap.xml generation
  • ✅ Robots.txt configuration
  • ✅ Canonical URLs
  • ✅ Image optimization with Next.js Image component
  • ✅ Lazy loading for images

Performance

  • ✅ Next.js Image optimization
  • ✅ WebP/AVIF image formats
  • ✅ Responsive images
  • ✅ Build optimizations

Dark Mode

  • ✅ next-themes integration
  • ✅ System preference detection
  • ✅ Theme persistence
  • ✅ Theme toggle in header
  • ✅ All components support dark mode
  • ✅ Charts and graphs adapt to theme
  • ✅ Smooth theme transitions

Testing SEO

Run these commands to test SEO:

# Build for production
npm run build

# Test with Lighthouse
npx lighthouse http://localhost:3000 --output html --output-path ./lighthouse-report.html

# Check structured data
# Visit: https://search.google.com/test/rich-results
# Or use: https://validator.schema.org/

# Check Open Graph
# Visit: https://opengraph.xyz/

Testing Dark Mode

# Start development server
npm run dev

# Test theme toggle
# - Click the sun/moon icon in header
# - Check system preference detection
# - Verify all components adapt
# - Test chart visibility in both themes

Folder structure

/src
  /app
    /auth
    /dashboard
    /projects
    /admin
  /components
  /services
    api.ts
    stellar.ts
  /hooks
  /utils
  /types
  /store

📌 Features

🎯 For Donors

  • Discover global fundraising campaigns
  • Donate in XLM or Stellar assets
  • Wallet integration (Freighter, Albedo, Lobstr)
  • On-chain transparency: verify all transactions

🎯 For Creators

  • Create social impact projects
  • Accept multi-asset contributions
  • Real-time donation tracking
  • Withdraw funds directly on-chain

🎯 For Admins

  • Campaign approval workflow
  • User & KYC management
  • Analytics dashboard

🏗️ Architecture Overview

StellarAid Frontend is built with:

  • Next.js 14
  • TailwindCSS
  • Stellar JavaScript SDK
  • Zustand (state management)

📌 How to Contribute

1. Fork the Repository

Click the “Fork” button in the top‑right of the GitHub repo and clone your fork:

git clone https://github.com/YOUR_USERNAME/stellaraid.git
cd stellaraid

2. Create a Branch

git checkout -b feature/add-donation-flow

3. Commit Messages

Use conventional commits:

feat: add wallet connection modal
fix: resolve donation API error
docs: update project README
refactor: clean up project creation form

4. Submitting a Pull Request (PR)

Push your branch:

git push origin feature/add-donation-flow

Open a Pull Request from your fork back to the main branch.

📜 License

MIT License — free to use, modify, and distribute.