Giter Club home page Giter Club logo

dharmikbanka23 / expense-guard Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 1.61 MB

Expense Guard streamlines expense management with easy entry, category organization, and analytics. Developed with Node.js, Express.js, and MongoDB, it securely tracks your budgets. OpenAI integration and predictive analysis techniques provides advanced financial insights. Empower yourself with this application for informed financial decisions.

Home Page: http://expenseguard.ddns.net/

License: MIT License

JavaScript 50.30% HTML 2.30% CSS 12.86% EJS 34.55%
amazon-ec2 amazon-s3 css expressjs google-charts html javascript jquery jwt mongodb mongoose multer nodejs nodemailer nyc openai rewire sinon socket-io supertest-mocha-chai

expense-guard's Introduction

Expense Guard Project

The Expense Guard Project is designed to help individuals manage their expenses effectively. This document provides an overview of the project, including its features, technologies used, and installation instructions.

Features

  • Expense Entry: Users can add, edit and delete expenses, that contains details such as amount, category, date, bills and descriptions.
  • Category Management: Ability to categorize and filter expenses for better understanding.
  • Dashboard Analytics: View all metrics and find the predictive analysis of your expenses.
  • Monthly Budget Tracking: Keep track of monthly budgets and compare them with actual spending.
  • Custom Configurations: Customize budgets and set notification preferences for wellness report.
  • Graphical Reports: Visualize expense data through charts and graphs.
  • User Authentication: Secure access with user accounts and authentication.
  • Chat Application: Chat with random users who are online or with ExpenseGPT.

Technologies Used

  • Frontend: HTML, CSS, JavaScript
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Storage: Amazon S3
  • Compute: Amazon EC2
  • Authentication: JSON Web Tokens (JWT)
  • Integration: OpenAI
  • Frameworks: Mongoose, JQuery, Multer, Nodemailer, Socket.io, Moment, Google Charts, Stupid Table
  • Unit Testing: Mocha, Chai, Chai-as-promised, Sinon, Sinon-chai, Supertest, Rewire, Nyc

Installation

  1. Clone the repository:

    git clone https://github.com/dharmikbanka23/expense-guard.git
  2. Navigate to the project folder:

    cd expense-guard
  3. Install dependencies:

    npm install
  4. Configure the environment variables:

    Create a .env file in the root directory and add necessary configurations.

    MONGODB_URI='YOUR_MONGODB_ACCESS_STRING'
    
    JWT_SECRET='YOUR_JWT_TOKEN'
    
    EMAIL='YOUR_EMAIL'
    PASSWORD='YOUR_APP_PASSWORD_FOR_EMAIL'
    
    OPENAI_API_KEY='YOUR_OPENAI_API_KEY'
    
    AWS_ACCESS_KEY_ID='YOUR_S3_ACCESS_KEY'
    AWS_SECRET_ACCESS_KEY='YOUR_S3_SECRET_KEY'
    AWS_REGION='YOUR_S3_REGION'
    AWS_S3_BUCKET_NAME='YOUR_S3_BUCKET_NAME'
  5. Run the application:

    npm start

    Visit http://localhost:4000 to access the Expense Guard application.

Usage

  1. Sign up or log in to your account:

    Visit the application's sign-up or login page to access your account. If you don't have an account, you'll need to sign up to get started.

  2. Add your expenses:

    Once logged in, navigate to the expense entry section. Provide details such as the amount spent, category, date of the expense, bill and description. Save the entry.

  3. View reports:

    Explore the graphical reports section to visualize your spending patterns. Charts and graphs will help you understand where your money is going.

  4. Access dashboard:

    Get all the important data at one place for better visualization. View the predictive analysis of your spendings.

  5. Track your spending patterns:

    Regularly check the reports to track your expenses against the set budget. Adjust your spending habits accordingly to stay within your financial goals.

  6. Global chat:

    In the dashboard, you could open up the chat feature and communicate with other users or ExpenseGPT on guarding expenses.

  7. Logout:

    For security, always log out of your account when you're done using the application. This ensures that your financial information remains secure.

Test Coverage

File % Stmts % Branch % Funcs % Lines Uncovered Line #s
All files 100 100 100 100
Expense Guard 100 100 100 100
app.js 100 100 100 100
Expense Guard/controllers 100 100 100 100
mailController.js 100 100 100 100
notificationController.js 100 100 100 100
s3Controller.js 100 100 100 100
Expense Guard/middleware 100 100 100 100
authenticateUser.js 100 100 100 100
authenticatedUser.js 100 100 100 100
Expense Guard/models 100 100 100 100
configurationModel.js 100 100 100 100
expenseModel.js 100 100 100 100
userModel.js 100 100 100 100
Expense Guard/routes 100 100 100 100
adjust.js 100 100 100 100
error.js 100 100 100 100
expenses.js 100 100 100 100
index.js 100 100 100 100
login.js 100 100 100 100
logout.js 100 100 100 100
register.js 100 100 100 100
statistics.js 100 100 100 100

Contributors

License

This project is licensed under the MIT License.

expense-guard's People

Contributors

dharmikbanka23 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.