This repository contains the official documentation for the Mpesa Pay JavaScript SDK. The documentation is built using Nextra, a Next.js-based library for static content generation. It provides comprehensive information and guidance on integrating Mpesa payments into your server-side applications using the Mpesa Pay JavaScript SDK.
The Mpesa Pay JavaScript SDK documentation is available at Mpesa Pay. The website provides easy navigation and a user-friendly interface for accessing the documentation.
To contribute to the documentation or make modifications, follow the steps below:
- Clone the repository:
git clone https://github.com/justinelut/mpesapaydocs.git- Navigate to the project directory:
cd mpesapay-docs- Install the dependencies:
yarn add- Start the development server:
yarn dev- Open your browser and visit http://localhost:4000 to view the documentation locally.
The documentation follows a structured format for easy navigation and readability. The main sections of the documentation can be found in the pages directory:
index: The landing page of the documentation.getting-started: Provides information on getting started with the Mpesa Pay JavaScript SDK, including installation and configuration instructions.mpesaexpress: Explains how to integrate Mpesa Express into your applications for initiating STK Push requests and processing payments.transactionstatus: Provides detailed instructions on integrating Transaction Status into your applications to check the status of Mpesa payments.businesstocustomer: Offers information on how to integrate Business-to-Customers payments using the Mpesa Pay JavaScript SDK.accountbalance: Contains instructions on retrieving the account balance for M-Pesa business accounts using the Mpesa Pay JavaScript SDK.contributing.mdx: Contains guidelines for contributing to the Mpesa Pay JavaScript SDK documentation, including information on how to clone the repository, create a new branch, commit changes, and open pull requests.
Feel free to modify or add new sections as needed to enhance the documentation.
Contributions to the Mpesa Pay JavaScript SDK documentation are welcome! If you find any errors, have suggestions for improvements, or want to contribute new sections, please follow the Contributing Guidelines.
The Mpesa Pay JavaScript SDK documentation is licensed under the MIT License. Make sure to review the license terms before using or contributing to the documentation.
Thank you for your interest in contributing to the Mpesa Pay JavaScript SDK documentation. We appreciate your contributions in improving the documentation and making it more accessible and helpful to the community. If you have any questions or need assistance, please don't hesitate to reach out to us. Happy documenting!