Skip to content

Latest commit

 

History

History
154 lines (95 loc) · 2.82 KB

README.md

File metadata and controls

154 lines (95 loc) · 2.82 KB
Raw

Money Transfer

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

Live Demo

Check out the live demo of the Money Transfer Web Application: Live Demo

Table of Contents

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

# Frontend

cd Frontend
npm install

# Backend

cd Backend
npm install
  1. Start the development server
# Backend

cd Backend
npm start

# Frontend

cd Frontend
npm run dev
  1. Open your browser and navigate to http://localhost:5173 to view the application.

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.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  • Fork the repository
  • Create your feature branch
git checkout -b feature/YourFeature
  • Commit your changes
git commit -am 'Add some feature'
  • Push to the branch
git push origin feature/YourFeature
  • Create a new Pull Request