Git Product home page Git Product logo

wallet-service's Introduction

Wallet Service

The wallet service is a comprehensive platform that provides wallet functionality for Demo Credit to receive loans they have been granted and also send money for repayments.

The API can be accessed through: https://victor-ilodiuba-lendsqr-be-test.onrender.com

Features

  • A user can create an account
  • A user can fund their account
  • A user can transfer funds to another user’s account
  • A user can withdraw funds from their account
  • A user with records in the Lendsqr Adjutor Karma blacklist would not be onboarded.

System Architecture

The service is built using a monolithic architecture. All components are tightly coupled and interdependent for simplicity and fast development.

E-R Diagram

The entity relationship diagram for the database is shown below:

E-R diagram

Getting Started

To run this service, you will require the following:

  • Node.js
  • Typescript
  • MySQL database
  • KnexJS ORM

Setup

  • Clone this repository and navigate to the directory.
  • Create a .env file in the root directory and fill in the environment variables required as stated in the .env.example file.
  • Run npm install in the project's root directory
  • Run npx knex migrate:latest in the project's root directory
  • If running in a development environment, run npm run dev, else, run npm start in the project's root directory
  • Access service from specified port

Tests

Unit tests for this service are located in the test folder. To run unittests, ensure all environment variables are correctly set, then run npm test in the project's root directory.

Service Design & Implementation Documentation

I documented what i have done, specifying the reasons for my approach and decisions i made that influenced the final outcome and it can be at: https://docs.google.com/document/d/1kfPc71BUgyY6l9qPDFtIsQWBJ7FNQCsMPdCYX8DIRbk/edit?usp=sharing

API Documentation

The Wallet Service API documentation can be found at: https://documenter.getpostman.com/view/27917912/2sA3XVAL89

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.