This repository contains the code and documentation for the TipZed Monetization MVP, focused on enabling Zambian creators to get paid locally. The backend API is built with Django REST Framework and provides endpoints for authentication, creator profiles, wallets, payments, payouts, and admin reconciliation. The frontend is built with React and integrates with the backend to provide a seamless user experience.
Core User Flows:
- Creators sign up, create profiles, set up payout accounts (mobile money or bank)
- Fans discover creators, send payments via mobile money
- Creators see balances, request payouts
- Admin approves payouts, reconciles transactions
Read the backend readme for API setup and development instructions: backend/README.md
Read the frontend readme for UI setup and development instructions: frontend/README.md
- User registration (email + password) and social login (Google OAuth)
- JWT authentication with access and refresh tokens
- Role-based access control (creator, patron, admin, guest)
- JWT authentication & refresh tokens
- Public creator profiles (discoverable)
- Profile editing
- Dashboard for creators to view stats, manage payouts
- Immutable transaction ledger (append-only)
- Wallet balance calculated from ledger
- No manual balance editing (audit trail)
- Receive weekly payouts from TIPZED
- Idempotent payment processing (prevent duplicates)
- Initiate mobile money payments
- Webhook handling from mobile money provider
- Payment state machine (pending → success/failed)
- Idempotency (prevent duplicate charges)
- Creator payout requests
- Admin approval/rejection
- Automatic weekly payout processing
- Admin reconciliation dashboard
- backend/README.md - Backend setup & development
- frontend/README.md - Frontend setup & development
- Swagger UI:
http://localhost:8000/api/docs/ - Redocs UI:
http://localhost:8000/api/redocs/ - Postman Collection: postman_collection.json
| Role | Name | Responsibility |
|---|---|---|
| Project Lead | Peter Zyambo | Overall MVP delivery, Backend lead, integration owner |
| Frontend Lead | George Mugale | Core UI, state management |
| Frontend Support | Barnabas Mwaipaya | Styling, responsiveness, polish |
| Backend Support, QA | Sepiso23 | services, database, polish |
| QA | Team | Testing, verification |
Having trouble?
- Backend issues → Contact Peter
- Frontend issues → Contact George or Barnabas
- Integration issues → Contact Peter
MIT License - See LICENSE file
"If it doesn't help a creator get paid, don't ship it."
Every decision, every line of code, every feature should move us toward this goal. Keep this focus and we will succeed.
Want to contribute? Start here:
-
Read CONTRIBUTION.md for:
-
Create issues using templates in .github/ISSUE_TEMPLATE
Created: January 27, 2026
Status: MVP In Development
Timeline: 2-week sprint
Goal: Enable Zambian creators to get paid reliably.