Skip to content

Latest commit

 

History

History
123 lines (99 loc) · 4.4 KB

README.md

File metadata and controls

123 lines (99 loc) · 4.4 KB
Raw

Hisaab

1000038444

Overview

Hisaab is a React-based web application which I created as a website for my flatmates to manage and log our joint expenses, the app allows users to add, track, and manage entries for items purchased, and calculates how much each person owes. The app also has charts windows and activities pane.

Table of Contents

Installation

  1. Clone the repository: 
    git clone https://github.com/asdhamidi/hisaab.git
cd hisaab
  2. Install the dependencies: 
    npm install
  3. Run the application: 
    npm start

Project Structure

hisaab/
├── public/
├── src/
│   ├── components/
│   │   ├── activities.js
│   │   ├── api-handling.js
│   │   ├── board.js
│   │   ├── editor.js
│   │   ├── login.js
│   │   ├── navbar.js
│   │   ├── owe-details.js
│   │   ├── pop-up.js
│   │   ├── summary.js
│   │   ├── stats.js
│   ├── App.js
│   ├── App.css
│   ├── index.js
├── package.json
└── README.md

Usage

  1. Login/Register:

    • The app starts with a login/register screen. Users can either log in or register as a new user using the provided registration code.

  2. Adding Entries:

    • Once logged in, users can add new entries by clicking the New Entry button on the navbar. Users need to input details like items, price, notes, and who owes the amount. If needed user can make backdated entries, as well.

  3. Viewing and Editing Entries:

    • Entries are listed on the board. Users can click their own entries to edit them. Non-editable entries can be clicked to view details in a pop-up.

  4. Summary:

    • The summary section shows the total amount spent and the amount owed by the user. Users can click on button in the summary pane to see a detailed breakdown of amounts owed to each person, charts to show the spending trends over the month, how much each person spent, and activities of people with regards to making and updating entries.

APIs Used

The app uses Axios for API handling and backend communication. The base URL is set to:

const axiosInstance = axios.create({
  baseURL: "https://hisaab-ashy.vercel.app/",
  headers: {
    "Content-Type": "application/json",
  },
});

Axios interceptors are used to attach the authorization token to requests:

axiosInstance.interceptors.request.use(
  (config) => {
    const token = localStorage.getItem("token");
    if (token && !config.url.includes("/login")) {
      config.headers["Authorization"] = `Bearer ${token}`;
    }
    return config;
  },
  (error) => Promise.reject(error)
);

Components

  • App.js: The main component that manages routing and the overall structure of the app.
  • Login.js: Manages user authentication (login and registration).
  • Board.js: Displays the list of entries.
  • Editor.js: Provides a form for creating or editing an entry.
  • Navbar.js: The navigation bar that includes logout functionality, a filter for selecting the month, and downloading the entries for the month in a CSV file.
  • Summary.js: Displays summary statistics such as total amount spent and owed.
  • OweDetails.js: Shows card-based information on what other people owes the user and what the user owes to other people.
  • stats.js: Shows line charts for combined expense trends over the month or total expense made by each person in a bar chart, based on the user's choice from the drop down menu.
  • Activites.js: Displays activities of fellow users about creating or updating entries.
  • Popup.js: Displays entry details and previous versions of the entry, if edited, in a pop-up window.
  • ApiHandling.js: Handles API requests using Axios.

Technologies Used

  • Frontend: React, React Router, Canvas.js, react-spinners
  • API Handling: Axios
  • Styling: CSS
  • Build & Deployment: React Scripts, gh-pages

License

This project is licensed under... well, no specific license. Feel free to use it however you like. Consider it public domain—use it, modify it, share it, or just ignore it.