kelvingakuo / mock-mpesa-transactions-app

MOCK MPESA TRANSACTIONS APP

An app built to consume the Transactions REST API documented here: http://bit.ly/gakuoapidoc

Overview

• Frontend
  An implementation of a web app consuming the REST API.
  The app is built using:
  • AngularJS 1.5 - UI/UX
  • ExpressJS - Routing
• Backend
  And implementation of the API.
  The API is built using:
  • MongoDB - Persistence of data
  • ExpressJS - Routing

Prerequisites

Both the fronted and backend need NPM and Node, at the bare minimum

• Install NodeJS This installation should come packaged with NPM. Confirm:

  node -v
  npm -v

• Install nodemon A nifty package that restarts the server at every file change

  npm install -g nodemon --save

Installation

• Frontend

    cd Frontend/  
    npm install  
    nodemon start

• Backend

    cd Backend/  
    npm install  
    nodemon start

Directory structure

• Frontend
  • package.json - App description, dependencies etc
  • /router.js - The entry point
  • /package-lock.json - Comprehensive list of dependencies
  • /views - HTML files served by router.js
  • /public - Assets e.g JS files
• Backend
  • package.json - App description, dependencies etc
  • /server.js - The entry point
  • /package-lock.json - Comprehensive list of dependencies

Usage

Both the frontend and backend are on Heroku. The app can be accesed via:http://bit.ly/gakuowebapp

Authors

• Kelvin Gakuo

License

This project is licensed under the WTFPL License

Acknowledgments

• The internet
• General awesomeness of humanity