StellarYield

Notice: the original Vercel domain submitted during Drips Wave review was claimed by a squatter. The current live deployment is stellaryield.vercel.app.

StellarYield is a Stellar-native DeFi dashboard and automated vault project. The repository includes a Vite frontend in client/, an Express backend in server/, and Soroban smart contracts in contracts/.

Repository Layout

• client/ - React + Vite frontend
• server/ - Node.js + Express backend
• contracts/ - Soroban smart contracts and Rust workspace
• docs/ - contributor and release documentation
• .github/workflows/ci.yml - pull request validation workflow

Getting Started

Prerequisites

• Node.js 20+
• npm 10+
• Rust stable toolchain
• Soroban CLI for contract work

Clone the Repository

git clone https://github.com/YOUR_GITHUB_NAME/StellarYield.git
cd StellarYield

Frontend Setup

cd client
npm ci
npm run dev

The frontend runs on http://localhost:5173.

Backend Setup

cd server
npm ci
npm run dev

The backend runs on http://localhost:3001.

Contract Verification

cd contracts
cargo fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace

Verification Commands

Client

cd client
npm run lint
npm run build
npm run test

Server

cd server
npm run lint
npm run build
npm test

Contracts

cd contracts
cargo fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace

README Verification

The CI workflow also checks that the documented setup and verification commands in this README stay in sync with the repo:

node scripts/verify-readme-commands.js

CI Failure Artifacts

When the pull request workflow fails, GitHub Actions uploads frontend failure artifacts and contract test logs for a short retention window. Open the failed workflow run in the GitHub Actions tab and look for the Artifacts section near the bottom of the run summary.

Contributor and Release Docs

The mock API will be available at http://localhost:3001

🧪 Post-deploy smoke test

After deploying the frontend + backend, run the included smoke test to validate basic reachability.

FRONTEND_URL="https://your-frontend-url" \
BACKEND_URL="https://your-backend-url" \
bash scripts/smoke-test.sh

• Checks: GET /api/yields, GET /api/metrics, and the frontend root.
• Config: FRONTEND_URL and BACKEND_URL environment variables. 🌊 Contributing via Drips Wave We are proudly participating in the Stellar Wave Program via Drips! We are actively looking for Web3 full-stack and Rust developers. Check our open issues labeled Stellar Wave, apply via the Drips App, and submit your PR to earn rewards funded by the Stellar Development Foundation!
• Contributing Guide
• Pre-commit Formatting and Verification Guide
• Release Checklist

Drips Wave

---

✅ Post-deploy smoke test

After merge/deploy, you can quickly verify the public app + API are reachable:

npm run smoke-test

Configuration

Override targets via environment variables:

FRONTEND_URL="https://stellaryield.vercel.app" \
BACKEND_URL="https://your-backend.example.com" \
npm run smoke-test

Optional path overrides:

• BACKEND_HEALTH_PATH (default: /api/health)
• BACKEND_YIELDS_PATH (default: /api/yields)
• FRONTEND_ASSET_PATH (default: /favicon.ico)

StellarYield is participating in the Stellar Wave Program via Drips. Contributors can pick up open issues, submit focused pull requests, and validate their work locally with the commands above before opening a PR.