https://github.com/emmanuelkdev/paybudddy
Paybuddy (Placeholder name) is a business web app designed to help business individuals keep track of their manual transactions with clients. The app has room for improvement and currently only includes key features that paint the overall picture.
https://github.com/emmanuelkdev/paybudddy
express graphql mongodb mongoose nodejs nodemailer react typescript vite
Last synced: 2 months ago
JSON representation
Paybuddy (Placeholder name) is a business web app designed to help business individuals keep track of their manual transactions with clients. The app has room for improvement and currently only includes key features that paint the overall picture.
- Host: GitHub
- URL: https://github.com/emmanuelkdev/paybudddy
- Owner: EmmanuelKdev
- Created: 2024-10-18T08:30:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-25T14:11:02.000Z (over 1 year ago)
- Last Synced: 2024-12-25T15:18:58.521Z (over 1 year ago)
- Topics: express, graphql, mongodb, mongoose, nodejs, nodemailer, react, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 1.12 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Paybuddy 💼
_______________________
## UI Visuals 📸
________________________
________________________
### Purpose 🎯
Paybuddy (Placeholder name) is a business web app designed to help business individuals keep track of their manual transactions with clients. The app has room for improvement and currently only includes key features that paint the overall picture.
### Main Features 🌟
* 🔐 User registration and authentication
* 👤 Login and user profile
* 💸 Create Transaction
* 🗑️ Delete Transaction
* ✅ Complete Transaction
* 📊 Transaction Analytics
### Future Features 🚀
* 🧾 Invoicing Features
* 💳 Online payment handling
* 🧮 Income calculator
* 📋 Client record
## Technology Stack 🛠️
### Front-End 🌐
* 🟦 TypeScript
* ⚛️ React + Vite and GraphQL
### Back-End 🖥️
* 🟦 TypeScript
* 🚀 Express Node.js
* 🔗 GraphQL
* 🗄️ NoSQL - MongoDB
## How to Run the App 🏃♂️
### Prerequisites
- **Node.js**: Ensure you have Node.js installed. You can download it from [nodejs.org](https://nodejs.org/).
- **MongoDB**: Ensure you have MongoDB installed and running. You can download it from [mongodb.com](https://www.mongodb.com/).
### Step-by-Step Guide
1. **Clone the Repository**:
```bash
git clone https://github.com/EmmanuelKdev/Paybudddy.git
cd Paybudddy
2. **Copy example.env contents in the back-end and paste them in a new .env file within the same folder**
3. **Go to the terminal and make sure you are the root folder**
4. **Back-End**
```bash
cd pay-buddy-Backend
npm install
5. **After installation type:**
```bash
npm run dev
6. **Front-End**
```bash
cd paybuddy-frontEnd
npm install
7. **After installation type:**
```bash
npm run dev
Go to http://localhost:5173/ to view the front end