Skip to content

A USSD Code app built with NodeJs + Postgres using Africa's talking platform.

License

Notifications You must be signed in to change notification settings

victkarangwa/USSD-Code-App

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

A USSD Code app built with NodeJs + Postgres using Africa's talking platform.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published