fegoworks / ewallet-api

A simple wallet REST API to allow customers pre-load their wallet from their Debit cards and transfer virtual money as a gift to other customers within the platform

eWallet API

A simple wallet REST API to allow customers pre-load their wallet from their Debit cards and transfer virtual money as a gift to other customers within the platform

Table of Contents

• Getting Started
• Technology Stack
• Installation
• Usage
• Testing
• API Endpoints
• Questions
• Support or Contribution

Getting Started

This is a backend javascript application built with Node JS using Express framework. The application runs on a PostgreSQL database and is live on heroku -ewallet-api

Technology Stack

Server Side

1. NodeJS
2. Express FrameWork
3. PostgreSQL
4. Sequelize

Installation

1. Install Node JS.

2. Clone the repository here

3. [cd] into the root of the project directory.

4. Run npm install on the terminal to install project dependecies

5. Create a .env file in the root directory of the application. Example of the content of a .env file is shown in the .env.sample

6. Start the application: Different Build Environments

Production

npm run start

Development

npm run start:dev

Testing

Sever side tests - Run npm test on the terminal while within the project root directory.

Server side testing is achieved through use of chai-http, mocha and chai packages. chai-http is used to make requests to the api and mocha is the testing framework and chai is the exception library. They will both be installed when you run npm install and the tests will run when you run npm test.

API Endpoints

Please view API Documentation here

Questions

For more details contact [email protected]

Support or Contribution

For any suggestions or contributions or issues please do raise them or email me. For Contributions, Please clone the repo and implement a PR I would appreciate it