Skip to content

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.

Notifications You must be signed in to change notification settings

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

No packages published

Languages