• Postman Documentation: Click Here
• API Production Link: Click here
• Github Repository: Click here

These features are limited to:

• Accounts
• Deposits
• Transfers
• Withdrawals
• Transactions

This features also refers to the Wallet of the said user, which holds user information and available balance.

With this, the user is able to deposit/fund their account which the value will be reflected in the available balance.

This makes an authorized user to be able to move monetary alue from its accounts to another user.

Since we have the monetary value stored in an account, the user can decided to withdraw to a physical bank account.

The image below is an full representation of the database schema.

List of available routes:

Auth routes:
POST /api/auth/register - register
POST /api/auth/login - login\

Account routes:
POST /api/account/deposit - fund
POST /api/account/transfer - transfer
POST /api/account/withdraw - withdraw\

The environment variables can be found and modified in the .env file. They come with these default values:

# Port number
NODE_ENV=development
PORT=8000
ACCESSTOKENEXPIRESMINUTES=1500
REFRESHTOKENEXPIRESDAYS=1
JWT_AUTH_SECRET=bananpieisasweetpie
DB_NAME=lendsqr
DB_USER=root
DB_PASSWORD=root
DB_HOST=localhost
DB_PORT=8889
DB_DIALECT=mysql
PAYSTACK_SECRET_KEY=
PAYSTACK_PUBLIC_KEY=

src\
 |--config\         # Environment variables and configuration related things
 |--controllers\    # Route controllers (controller layer)
 |--middlewares\    # Custom express middlewares
 |--models\         # Mongoose models (data layer)
 |--routes\         # Routes
 |--services\       # Business logic (service layer)
 |--utilities\          # Utility classes and functions
 |--validations\    # Request data validation schemas
 |--interfaces\      # Interfaces
 |--server.ts       # App entry point
 |--knexfile.ts      # Knex config environment

Running locally:

npm run dev

Build:

npm run build

Running in production:

npm start