Code Monkey home page Code Monkey logo

ussd-code-app's Introduction

USSD Application Demo

USSD Aplication built with NodeJs + Postgres + Africa's Talking platform

Features

  • Authentication
  • Send money
  • Check savings
  • Change PIN
  • View statement

Staging environment base URL

https://my-ussd-app.herokuapp.com

Setting Up The Application in development environment

  1. Open your terminal

  2. Run git clone https://github.com/victkarangwa/USSD-Code-App.git OR Download the project

I. Setting up the environment

  1. Create a .env file reflecting to .env.example file

  2. Add the values to all environmental variables in .env file

  3. Make sure you have PostgreSQL installed (You can download it here)

II. Running the application

Open termin in the directory you clone the repo from:

  1. Run npm install to install all dependencies

  2. Using postgres, create database for both dev and testing environment. In your .env, database URL should be of this format: DATABASE_DEV_URL=postgres://[user]:[password]@[host]:[port/[db_name] ex: DATABASE_DEV_URL=postgres://postgres:1122@localhost:5432/ussd_db

  3. Run npm run db:migrate or yarn db:migrate to automatically create all necessary models

  4. Run npm run db:seed or yarn db:seed to populate data in the database

  5. Run npm run start:dev to start local development server. You can also simulate production server locally by running npm start

  6. Expose a web server running on your local machine to the internet using ngrok, for more about setting up ngrok use: https://dashboard.ngrok.com/get-started/setup

III. Setting up simulator with Africa's talking platform

Please read this article if you want to setup your own simulator

Sample Screenshots

initial page

Menu page

Saving page

Send Money page

Change PIN page

Authors

ussd-code-app's People

Contributors

victkarangwa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.