Evolve Payments Platform
Welcome to the internal developer documentation for the Evolve Payments Platform. This documentation is designed exclusively for our development team to understand the codebase structure, architecture, and development workflows.
Internal Only: This documentation is for team developers only and contains technical implementation details not meant for external users.
Project Overview
What is Evolve Payments Platform?
A B2B software marketplace and referral platform that connects software vendors with resellers, enabling commission-based sales of business software solutions across African markets.
Django 5.2.4
Python 3.8+
SQLite
REST API
System Roles
| Role | Description | Module |
|---|---|---|
| Admin | Platform owner (Lixnet) - manages platform, approves vendors, monitors transactions | App.admin |
| Business | End customers who purchase and use software products (ERP, SACCO, Payroll) | App.business |
| Reseller | Sales agents who promote products and earn commissions on referrals | App.reseller |
Quick Navigation
System Architecture
High-level system design, modules, and how components interact with each other.
Project Structure
Detailed breakdown of the codebase directory structure and file organization.
Admin Module
Admin management system for platform control and user management.
API Reference
Complete REST API documentation with endpoints and examples.
Current Implementation Status
Implemented Features
- Multi-tenant system architecture
- User authentication and role-based access
- Reseller commission tracking system
- Basic payment integration structure
- Admin dashboard foundation
- API structure for all modules
In Development
- Full Pesapal payment integration
- Advanced reporting features
- Email notification system
- SMS integration completion
Technology Stack
| Component | Technology | Version |
|---|---|---|
| Backend Framework | Django | 5.2.4 |
| Database | SQLite (dev) / PostgreSQL (prod) | - |
| API | Django REST Framework | - |
| Payment Gateway | Pesapal | v3 |
| SMS Service | SMSLeopard | - |
| Environment Config | python-decouple | 3.8 |
Development Commands
Common Commands
# Run development server
python manage.py runserver
# Apply migrations
python manage.py migrate
# Create superuser
python manage.py createsuperuser
# Run tests
python manage.py test
# Collect static files
python manage.py collectstatic
Note: This documentation is automatically updated. If you notice any outdated information, please update the source files and the changes will be reflected after the next deployment.