Skip to content

About

StellarAid Backend is the server-side API powering the StellarAid crowdfunding platform — a blockchain‑enabled system built on the Stellar network to support transparent, secure, and efficient fundraising for social impact initiatives.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

🌟 StellarAid

Blockchain-powered crowdfunding for global impact — transparent, borderless, and secure. StellarAid is an open-source, decentralized crowdfunding platform built on the Stellar Network & Soroban smart contracts. It enables creators to raise funds in XLM or any Stellar-based asset, while donors enjoy transparent, verifiable on-chain contributions. Whether it’s humanitarian campaigns, community causes, startups, or global charity projects — StellarAid brings trust, transparency, and financial accessibility to fundraising.

📖 About StellarAid

StellarAid empowers individuals and organizations to launch fundraising campaigns with full blockchain transparency. The platform supports multi-asset contributions, verifiable donation trails, automated fund releases through Soroban smart contracts, and wallet-based authentication.

  • 🔐 Decentralized & Secure — Wallet-based login, non-custodial flows
  • 💸 Multi-Asset Support — XLM, USDC, NGNT, custom Stellar assets
  • 📊 Transparent — Every donation visible and verifiable on-chain
  • ⚙️ Modular & Open Source — Easy for contributors and developers

🏗 Organization Repositories

  • stellarAid-api → Backend services (NestJS + PostgreSQL )

    • User authentication (wallet + email verification)
    • Campaign approval workflow
    • Donation tracking + analytics
    • Notifications (email/SMS)
    • Admin API endpoints
  • the repo includes:

/docs        → Technical documentation
/examples    → Sample integrations
/scripts     → Dev and deployment utilities

🔑 How StellarAid Works

  • 1️⃣ User connects Stellar wallet (Freighter, Albedo, Lobstr)
  • 2️⃣ Creator launches a campaign → stored in backend + contract ref
  • 3️⃣ Donors contribute using Stellar assets
  • 4️⃣ Soroban contract escrows funds safely
  • 5️⃣ Creators withdraw funds securely on-chain
  • 6️⃣ Admin tools handle verification, fraud detection & analytics Everything is transparent, globally accessible, and verifiable.

🛠 Tech Stack

⚙️ Backend Services

  • NestJS (modular monolith)
  • PostgreSQL (primary data store)
  • Redis (cache, rate-limits, nonce store)
  • Nodemailer (notifications)

🗄 Data Layer

  • PostgreSQL for core data
  • Redis for caching + session flow
  • Optional IPFS for media (campaign images, proofs)

🚀 Roadmap

Phase 1 (MVP)

  • User registration + wallet login
  • Create & approve campaigns
  • Donate using XLM/USDC
  • Basic dashboard & on-chain transparency
  • Core Soroban contract (escrow + withdraw)

Phase 2

  • Email verification + KYC workflow
  • Advanced analytics
  • Multi-asset campaign support
  • Dispute handling
  • Social login (GitHub/Twitter/Discord)

Phase 3

  • Automated payout schedules
  • Community governance
  • Cross-border NGO support
  • Trust badges & identity verification

Phase 4

  • AI-driven fraud scoring
  • Multi-chain campaign expansion
  • Ecosystem grant program

⚙️ Environment Configuration

Configuration is read from process environment variables, with built-in defaults so the app can start without an environment file. Each environment has an example file documenting the supported variables:

Environment Example file
Development .env.development.example
Test .env.test.example
Production .env.production.example

Copy the relevant example (for example, cp .env.development.example .env.development), adjust the values, and provide them to the process through your shell, process manager, or deployment platform. Real environment files are ignored by Git; only the .example files belong in the repository.

NODE_ENV identifies the target environment. PORT controls the listening port and defaults to 3000 when unset. Never place real secrets in the example files.

🚨 Error Responses

Errors are returned by the global HTTP exception filter in a consistent envelope:

{
  "statusCode": 404,
  "message": "Cannot GET /missing",
  "path": "/missing",
  "timestamp": "2026-01-01T00:00:00.000Z"
}

statusCode and message come from the thrown HttpException; unexpected errors are reported as a 500 with a generic message.

🌐 CORS

Cross-origin requests are enabled for local development by default. To restrict them, set CORS_ORIGIN to a comma-separated list of allowed origins, for example:

CORS_ORIGIN=https://app.stellaraid.example,https://admin.stellaraid.example

🔌 API Endpoints

All routes are served under the global /api prefix.

  • GET /api — returns the current greeting ("Hello World!"). All routes are served under the versioned /api/v1 prefix.

  • GET /api/v1 — returns the current greeting ("Hello World!").

📦 Import Aliases

Source files can import from src/ using the @/* alias instead of deep relative paths:

import { AppService } from '@/app.service';

The alias is declared in tsconfig.json and mapped for Jest in package.json and test/jest-e2e.json. Keep new imports consistent with this convention.

⚙️ Environment Variables

Supported environment variables are documented in .env.example. Copy it to .env and adjust the values for your environment:

cp .env.example .env

PORT controls the port the API listens on and defaults to 3000 when unset. Only example values belong in .env.example; never commit real secrets.

🤝 Contributing

StellarAid is fully open-source and welcomes contributions from:

  • Blockchain engineers
  • Rust/Soroban developers
  • Full-stack devs
  • Designers & documentation writers
  • Community moderators

See CONTRIBUTING.md for contribution workflow, code style, and development setup.

📜 License

StellarAid is released under the MIT License, allowing free use, modification, and distribution with attribution.

🌐 Join the StellarAid Journey

Together, we can expand access to transparent, borderless fundraising — empowering communities and creators worldwide.

About

StellarAid Backend is the server-side API powering the StellarAid crowdfunding platform — a blockchain‑enabled system built on the Stellar network to support transparent, secure, and efficient fundraising for social impact initiatives.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages