Welcome to the Payments App! This project provides a secure platform for transferring money, managing user accounts, and viewing transaction details. It consists of both frontend and backend components.
- User Authentication: Signup and Signin functionalities.
- Account Management: Update user credentials.
- Balance Management: View current balance and transfer money.
- Search and Add Friends: Search for friends to transfer money.
The project is divided into two main parts:
- Backend: Built with Node.js and Express.js, it handles the API routes and database operations.
- Frontend: Built with React and Vite, it provides the user interface for interacting with the application.
The backend provides several API routes for managing accounts, authentication, and user details. You can find detailed information about these routes in the backend's README file.
The frontend includes several pages like Dashboard, Home, Signin, Signup, Send Money, and Settings. Each page provides specific functionalities to the user. Detailed descriptions of these pages can be found in the frontend's README file.
- Node.js (v14 or higher)
- npm (v6 or higher)
- Vite
-
Clone the repository:
git clone https://github.com/yourusername/payments-app.git cd payments-app
-
Install backend dependencies:
cd backend npm install
-
Install frontend dependencies:
cd ../frontend npm install
-
Configure environment variables:
Create a
.env
file in thebackend
directory and add your configurations (e.g., database connection string, JWT secret). -
Start the backend server:
cd backend npm start
The backend server will start on
http://localhost:3000
.
-
Start the frontend server:
cd ../frontend npm run dev
The frontend application will start on
http://localhost:5173
.
To test the backend and frontend applications, you can use tools like Postman (for API testing) and your browser (for frontend testing).
We welcome contributions to the project. If you have any ideas or suggestions, please feel free to open an issue or submit a pull request.
This project is licensed under the MIT License.
If you have any questions or need further assistance, please contact me.