Skip to content

EmmanuelKdev/Paybudddy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Paybuddy 💼


UI Visuals 📸


fig 1 fig 2 fig 3 fig 4


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.
  • MongoDB: Ensure you have MongoDB installed and running. You can download it from mongodb.com.

Step-by-Step Guide

  1. Clone the Repository:

    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

      cd pay-buddy-Backend
      npm install
    
  5. After installation type:

    npm run dev
    
  6. Front-End

        cd paybuddy-frontEnd
        npm install
    
  7. After installation type:

      npm run dev
    
    
    

Go to http://localhost:5173/ to view the front end

About

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.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages