Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
17 lines (10 loc) · 746 Bytes

CONTRIBUTING.md

File metadata and controls

17 lines (10 loc) · 746 Bytes

Contributing

Contributions are always welcome especially adding the available templates.

Setup

Run npm install then node . to run the project locally.

Format

Create a folder with the format mpesa-<framework>-<api>. For example mpesa-rails-c2b or mpesa-django-express. Frameworks and APIs are listed inside utils/contents.ts file.

Your API should have the following endpoints:

  • /api/example/stk - A POST endpoint that Handles the STK push and takes in phone and amount in the request body.
  • /api/example/callback - A POST endpoint that acts as a hook to listen to callbacks from the Daraja platform.
  • Make sure to add a README.md file with instructions on how to setup the project once generated.