Skip to main content

Getting Started with SunCulture Documentation

Welcome to the SunCulture technical documentation portal. This comprehensive resource provides detailed information about our applications, APIs, and development processes.

Available Applications​

AMT Backend (Production)​

Our Account Management Tool backend is a comprehensive TypeScript-based API server that handles:

  • Customer account lifecycle management
  • Payment processing and reconciliation
  • Product catalog and inventory
  • Commission calculations
  • KYC verification

Quick Links:

Coming Soon Applications​

We're continuously expanding our documentation to cover:

  • 360 Platform - Frontend application for internal operations
  • FMA (Field Management App) - Mobile app for field agents
  • Customer Portal - Self-service customer management
  • M-Pesa Integration - Payment gateway services
  • Sales Portal - Sales team management system
  • IoT Platform - Device monitoring and management

Documentation Structure​

Each application documentation includes:

📖 Introduction​

Overview of the application, key features, and business context

🚀 Getting Started​

Setup instructions, prerequisites, and basic configuration

🏗️ Architecture​

System design, components, and architectural patterns

📡 API Reference​

Complete endpoint documentation with examples

🗃️ Database​

Schema documentation and data models

🚀 Deployment​

Production deployment guides and best practices

How to Use This Documentation​

  1. Browse Applications: Use the sidebar to navigate between different applications
  2. Search: Use the search bar to find specific topics quickly
  3. Code Examples: Copy and paste ready-to-use code snippets
  4. API Testing: Try endpoints directly from the documentation

Need Help?​

  • Technical Issues: Contact the development team
  • Documentation Updates: Submit pull requests to our GitHub repository
  • Feature Requests: Create issues in the respective application repositories

Contributing​

This documentation is maintained by the SunCulture development team. We welcome contributions:

  1. Fork the documentation repository
  2. Make your changes
  3. Submit a pull request

Next Steps: Start with the AMT Backend documentation to explore our most comprehensive API platform.