TeeYml/Stellar-MicroPay

โ˜… 0Forks 0TypeScriptGitHub โ†—Compare

Project website โ†—

README

๐ŸŒŸ Stellar MicroPay

Cross-border micro-payments, powered by the Stellar blockchain.

License: MIT PRs Welcome Stellar

Stellar MicroPay is an open-source platform that lets anyone send small payments across borders instantly using XLM on the Stellar network. No banks. No high fees. No waiting.


โœจ Features (v1)

  • ๐Ÿ”— Connect Wallet โ€” Freighter browser wallet integration
  • ๐Ÿ’ธ Send XLM โ€” Send micro-payments to any Stellar address globally
  • ๐Ÿ“œ Transaction History โ€” View your recent payment activity
  • ๐ŸŒ Cross-border โ€” Works anywhere in the world, near-zero fees

๐Ÿ—‚ Project Structure

stellar-micropay/
โ”œโ”€โ”€ frontend/          # Next.js + React + Tailwind CSS
โ”œโ”€โ”€ backend/           # Node.js + Express API
โ”œโ”€โ”€ contracts/         # Stellar Soroban smart contracts (Rust)
โ”œโ”€โ”€ docs/              # Architecture & API documentation
โ”œโ”€โ”€ scripts/           # Deployment & utility scripts
โ”œโ”€โ”€ .github/           # CI/CD workflows & issue templates
โ”œโ”€โ”€ CONTRIBUTING.md
โ”œโ”€โ”€ ROADMAP.md
โ””โ”€โ”€ LICENSE

๐Ÿš€ Quick Start

Prerequisites

Tool Version
Node.js โ‰ฅ 18.x
npm / yarn Latest
Rust + Cargo โ‰ฅ 1.74 (for contracts)
Freighter Wallet Browser extension
Docker + Compose โ‰ฅ 24.x (optional, recommended)

1. Clone the repository

git clone https://github.com/your-org/stellar-micropay.git
cd stellar-micropay

2. Option A โ€” Docker (recommended)

The fastest way to get a fully working dev environment with hot-reload:

docker compose up

Editing any frontend or backend file reflects instantly without restarting containers.

For a production build:

docker compose -f docker-compose.prod.yml up --build

2. Option B โ€” Manual Setup

Run the setup script to install all dependencies and copy env files:

chmod +x scripts/setup-dev.sh
./scripts/setup-dev.sh

Then start each service in a separate terminal:

# Terminal 1
cd frontend && npm run dev   # โ†’ http://localhost:3000

# Terminal 2
cd backend && npm run dev    # โ†’ http://localhost:4000

3. Build Soroban Contracts (optional)

cd contracts/stellar-micropay-contract
cargo build --target wasm32-unknown-unknown --release

๐Ÿ”‘ Environment Variables

Frontend (frontend/.env.local)

NEXT_PUBLIC_STELLAR_NETWORK=testnet
NEXT_PUBLIC_HORIZON_URL=https://horizon-testnet.stellar.org
NEXT_PUBLIC_API_URL=http://localhost:4000

Backend (backend/.env)

PORT=4000
STELLAR_NETWORK=testnet
HORIZON_URL=https://horizon-testnet.stellar.org

๐Ÿงช Get Testnet XLM

  1. Install Freighter Wallet
  2. Switch to Testnet in Freighter settings
  3. Visit Stellar Friendbot and paste your public key
  4. You'll receive 10,000 test XLM instantly

๐Ÿค Contributing

We love contributions! See CONTRIBUTING.md to get started.

๐Ÿ—บ Roadmap

See ROADMAP.md for planned features.

๐Ÿ“„ License

MIT โ€” see LICENSE

Contributors

Emmy123222iamTissanjohnsmccaingboigweManuelshubNanle-codeThe-Big-Dannybamiebot-makermunyanezaarmelRobinsonchiziteremDanto1606njohnchiMavDavisTeeYmlcyber-excel10peternnadi1999

Issues