Skip to content

README.md

Latest commit

 

History

History
72 lines (48 loc) · 2.12 KB

README.md

File metadata and controls

72 lines (48 loc) · 2.12 KB

PayTM

Welcome to the PayTM Clone project! This is the basic version of PayTM and this project aims to replicate the basic functionality of PayTM, allowing users to perform transactions, view their account balance, and interact with other users.

Features

  • User Authentication & Authorization using JWT
  • View Account Balance
  • Search and view other users
  • Send money to other users' accounts

Database Transactions

The PayTM Clone project implements MongoDB Transactions to ensure data consistency and reliability. Transactions follow the ACID properties of databases, ensuring that transactions are either fully completed and committed or reverted back in case of issues, thus preventing inconsistencies in the database.

Techn Stack

  • Frontend: React.js, Tailwind CSS
  • Backend: Node.js, Express.js
  • Database: MongoDB

Getting Started

To get started with the PayTM Clone project, follow these steps:

  1. Clone the Repository: Clone the repository from GitHub:

    git clone git@github.com:33Frok1e/PayTM.git

  2. Set Environment Variables: Navigate to the frontend and backend folders and add necessary environment variables. You may need to create a .env file and configure it with required variables: In the backend/.env file:

    MONGO_URL = your-mongo-url
PORT = 3000
JWT_SECRET = your-jwt-secret

    In the frontend/.env file:

    VITE_SERVER_URL = your-server-url

  3. Install Dependencies: Install dependencies in the frontend and backend folders using npm or yarn:

    cd frontend
npm install
cd ../backend
npm install

  4. Start the Backend Server: In the backend folder, start the development server:

    node index.js // Whatever your root file name

  5. Start the Frontend: In the frontend folder, start the frontend application:

    npm run dev

Contributions

Contributions to the PayTM Clone project are welcome! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.

Thank you for using PayTM Clone! Happy Coding! 🚀