Skip to content

ZaidSunasra/Budget-Buddy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

Budget Buddy

An expense tracker app which helps user to track and manage their expenses and income.

Budget Buddy includes:-

  • User Login and Authentication
  • Perform CRUD operations on Expense
  • Responsive
  • Visualize User Expenses by Category
  • Display User Expenses by Date
  • PWA (Progressive Web App)
  • Budgeting for Users

Getting Started

Prerequisites

Installation Guide

Fork the Repository: Click on the Fork button at the top-right corner of this repository to create a copy in your GitHub account.

Clone the repository:

git clone https://github.com/ZaidSunasra/Budget-Buddy.git

Navigate to the project directory

Explained below

Create a new branch to work on:

git checkout -b feature/your-feature-name

Make Changes

git add .
git commit -m "Add: Description of changes"

Push Changes to your forked repository:

git push origin feature/your-feature-name

Open a Pull Request: Go to the original repository and click on Pull Request. Fill in the details and submit your PR.

Project Navigation

cd server
npm install

Create a .env file Add following variables and replace the value with your

DATABASE_URL=YOUR DATABASE URL / POSTGRE PASSWORD
JWT_SECRET=YOUR JWT SECRET
PORT=3000
tsc --watch

Open a new terminal

cd server
nodemon dist/index.js

Open a new terminal

cd client
npm install
npm run dev

TECH STACK

React Node.js Express PostgreSQL Tailwind CSS

Tools

Postman Git Visual Studio Code


Still in development phase. Feel free to give suggestion and any new features.