IronJosh786/mt-vercel

Money Transfer

This project is a Full Stack MERN application designed for facilitating money transfers, akin to a financial transaction application.

Table of Contents

• Features

• Getting Started

• Prerequisites

• Installation

• Controllers

  • 1. User Controller

  • 2. Transaction Controller

• Models

  • 1. User Model

  • 2. Transaction Model

Features

• User registration and authentication
• User login/logout functionality
• View all registered users
• Send money to other users (new transaction)
• View transaction history
• Update user profile information

Getting Started

Prerequisites

Before setting up the project, ensure you have the following installed:

• Node.js

• npm (Node Package Manager)

Installation

1. Clone the repository:

   git clone https://github.com/IronJosh786/moneyTransfer.git

2. Change to the project directory

   cd moneyTransfer

3. Create a .env file in the root directory and configure the following environment variables:

   PORT,
   CORS_ORIGIN,
   MONGODB_URI,
   ACCESS_TOKEN_SECRET,
   ACCESS_TOKEN_EXPIRY,
   REFRESH_TOKEN_SECRET,
   REFRESH_TOKEN_EXPIRY,
   CLOUDINARY_CLOUD_NAME,
   CLOUDINARY_API_KEY,
   CLOUDINARY_API_SECRET

4. Install the dependencies

   npm install

5. Start the development server

   npm start

Controllers

1. User Controller

Handles user-related functionalities such as registration, login, viewing all users, and updating user profiles.

2. Transaction Controller

Manages transactions between users, including sending money to other users and viewing transaction history.

Models

1. User Model

Model for user information including username, email, password (hashed), and profile details.

2. Transaction Model

Model to store information about transactions, including sender, receiver, amount, date/time, and any additional details.