https://github.com/vectormike/glowing-memory
Wallet Service built with Nodejs, Typescript, Knex and MySQL
https://github.com/vectormike/glowing-memory
Last synced: 11 months ago
JSON representation
Wallet Service built with Nodejs, Typescript, Knex and MySQL
- Host: GitHub
- URL: https://github.com/vectormike/glowing-memory
- Owner: Vectormike
- Created: 2022-11-28T19:43:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-23T09:35:40.000Z (about 3 years ago)
- Last Synced: 2025-03-28T05:43:09.950Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 259 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Wallet Service**
#### **Submission Links**
- Postman Documentation: [Click Here](https://documenter.getpostman.com/view/5622145/2s8YsxvBW7)
- API Production Link: [Click here](https://victor-jonah-lendsqr-be-test.herokuapp.com/lendsqr)
- Github Repository: [Click here](https://github.com/Vectormike/glowing-memory)
---
## **Major features and Implementation**
These features are limited to:
- Accounts
- Deposits
- Transfers
- Withdrawals
- Transactions
### **Account:**
This features also refers to the Wallet of the said user, which holds user information and available balance.
### **Deposit:**
With this, the user is able to deposit/fund their account which the value will be reflected in the available balance.
### **Transfer:**
This makes an authorized user to be able to move monetary alue from its accounts to another user.
### **Withdrawal Feature:**
Since we have the monetary value stored in an account, the user can decided to withdraw to a physical bank account.
## Database Schema
The image below is an full representation of the database schema.
### API Endpoints
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\
## Environment Variables
The environment variables can be found and modified in the `.env` file. They come with these default values:
```bash
# 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=
```
## Project Structure
```
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
```
## Commands
Running locally:
```bash
npm run dev
```
Build:
```bash
npm run build
```
Running in production:
```bash
npm start
```