Skip to content

Latest commit

 

History

History
172 lines (127 loc) · 4.21 KB

README.md

File metadata and controls

172 lines (127 loc) · 4.21 KB

QuickSend

home-page

dashboard

QuickSend is an Easy, Fast, Reliable, and Secure money transfer Web application which makes sending money to friends and family with just a few clicks.

Table of Contents

Technologies Used

  • Frontend:

    • React
    • Javascript
    • Tailwind CSS

  • Backend:

    • Node.js
    • Express.js

Features

  • User Registration and Profiles: Users can create and update their accounts assigned unique ID to everyone.

  • Secure Authentication and Authorization: Implemented JWT and zod for authentication and authorization.

  • Transaction Sessions: Implement session management to handle transaction flows smoothly.

  • Send Money Functionality: Allow users to send money to friends and family.

  • Fast and Reliable Transactions: Use robust APIs or payment gateways to facilitate transfers.

  • Transaction History: Maintain a history of transactions for users to track their transfers.

Getting Started

Prerequisites

  • Node.js and npm installed on your machine.

Installation

With Docker Compose

  1. Clone the repository:

    git clone https://github.com/Ratangulati/QuickSend

  2. Navigate to the project directory:

    cd QuickSend

  3. Run Docker Compose:

    docker-compose up

    The app should now be running at http://localhost:5173.

With Docker

Frontend

  1. Clone the repository:

    git clone https://github.com/Ratangulati/QuickSend

  2. Navigate to the project frontend directory:

    cd QuickSend/frontend/

  3. Build docker image:

    docker build -t <your-image-name> .

  4. Run docker image:

    docker run -p 5173:5173 <your-image-name>

    The app should now be running at http://localhost:5173.

Backend

  1. Clone the repository:

    git clone https://github.com/Ratangulati/QuickSend

  2. Navigate to the project frontend directory:

    cd QuickSend/backend/

  3. Build docker image:

    docker build -t <your-image-name> .

  4. Run docker image:

    docker run -p 3000:3000 <your-image-name>

    The app should now be running at http://localhost:3000.

Without Docker

Frontend

  1. Clone the repository:

    git clone https://github.com/Ratangulati/QuickSend

  2. Navigate to the project frontend directory:

    cd QuickSend/frontend

  3. Install dependencies:

    npm install

  4. Start the development server:

    npm run dev

    The app should now be running at http://localhost:5173.

Backend

  1. Clone the repository:

    git clone https://github.com/Ratangulati/QuickSend

  2. Navigate to the project backend directory:

    cd QuickSend/backend/

  3. Install dependencies:

    npm install

  4. Start the development server:

    npm start

    The app should now be running at http://localhost:3000.

  5. Example config.js You can use in your backend

    module.exports = {
  JWT_SECRET: "your-secret",
  MONGO_URL: "your-mongo-url"
}

How to Contribute

To know how to contribute to the project visit CONTRIBUTING.md.