QR Pay

A cashless payment system using QR codes and mobile money.

Completed: December 2021

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact

About The Project

This project is a cashless payment system intended for public transport in Kenya. It is implemented using Django, Python and SQLite. QR Pay is managed by an admin who creates and posts QR codes with information such as routes and prices. When the QR code is scanned on a mobile phone, it triggers an STK push notification which requests the customer's Mpesa password, thus completing the payment.

Built With

• Django
• SQLite

Getting Started

To get this app running on your machine, simply clone the repository and ensure the following prerequisites are all installed.

Prerequisites

Have the following prerequisites:

• Python (version 3.90)
• Pip (latest version)
• Django (version 3.2.9)
• Bootstrap 4

Installation

1. Clone the repository

   git clone https://github.com/GituMbugua/qr-pay.git
   

2. Create a virtual environment

3. Install requirements

   (venv)$ pip install requirements.txt
   

4. Get your API key from the Safaricom developer portal

5. Add your keys and secrets to a .env file

   CONSUMER_KEY=<consumer_key>
   CONSUMER_SECRET=<consumer_secret>
   PASSKEY=<passkey>
   

6. Run the server

   (venv)$ python manage.py runserver
   

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Gitu Mbugua - gmbugua38@gmail.com

Project Link: https://github.com/GituMbugua/qr-pay

(back to top)