README.md

Demo Credit

An MVP (Minimum viable product) wallet service where a user can create, fund, withdraw, and transfer funds to another user’s account.

Table of Contents

1. Introduction
2. Features
3. Requirements
4. Getting Started
   • Installation
   • Configuration
   • Running the Project
5. Usage
6. API Documentation
7. Contributing
8. License

Introduction

Demo Credit is a Minimum viable product wallet service where a user can create, fund, withdraw, and transfer funds to another user’s account. It is built on Node and Express while persisting data with MySQL through Knex ORM.

Features

• Account creation
• Account funding
• Fund transfer
• Fund withdrawal

Requirements

List any prerequisites or dependencies needed to run your project.

• Node.js (LTS)
• Express
• TypeScript
• MySQL (version 8)
• Knex ORM
• JWT

Getting Started

Follow these steps to get started.

Installation

# Clone the repository
git clone https://github.com/ChiomaSarah/DemoCredit

# Navigate to the project directory

# Install dependencies
npm install

Start Application

# restart dev server with nodemon
npm start

# build typescript
npm run build

Database Migration

Run Migrations

# Run pending migrations
npx knex migrate:latest

Run seed files

npx knex seed:run

Endpoints

• createUser: http://localhost:7000/api/register
• userLogin: http://localhost:7000/api/login
• fundWallet: http://localhost:7000/api/fund-wallet
• transferFund: http://localhost:7000/api/transfer
• withdrawFund: http://localhost:7000/api/withdraw
• transactionHistory: http://localhost:7000/api/transactions