jake0011/budgetbuddy

A simple personal finance app

BudgetBuddy Requirement Analysis

This document outlines the deliverables produced during the requirement analysis phase of the BudgetBuddy project. Requirement analysis is the first and a critical step in the Software Development Life Cycle (SDLC) that ensures the final product aligns with the stakeholders' needs.

NB: Edem should check out this design and then this design too.

Project Deliverables:

1. Requirement Specification Document (RSD)

This section defines the functional and non-functional requirements for BudgetBuddy.

Functional Requirements

• User Authentication

  • Sign Up/Login: Users must securely create accounts and log in to the app.

• Income Management

  • Add Income: Users can add income from various sources.
  • Income Sources: Users can specify different income types to their account.

• Budget Planning

  • Draw Budget: Users can create budgets based on their total income, allocating funds to designated categories.

• Expense Tracking

  • Deduct Expenses: Users can input and categorize expenses, deducting them from their total income. Each entry requires amount and reason for the expense.

• Expenditure Review

  • Select Dates for Review: Users can choose specific dates to review their expenditures and compare them against their budget for those periods.

• Savings Calculation

  • Check Savings: Users can view accumulated savings over different periods.

• Advice and Reporting

  • Generate Reports: Users can generate reports based on selected dates to analyze their financial activities.
  • Financial Advice: The app should offer general and personalized(maybe later) financial advice based on users' income, expenses, and savings patterns.

Non-Functional Requirements

Security

• The application must ensure the secure handling of user data, including:
  • Encryption of sensitive information
  • Secure authentication mechanisms

Performance

• The application should:
  • Have minimal load times

Usability

• The user interface must be:
  • Intuitive
  • Easy to navigate
  • Cater to users with varying levels of technical proficiency

Scalability

• The system should be scalable to accommodate:
  • An increasing number of users
  • Additional features in the future

Reliability

• The application must be:
  • Reliable
  • Have minimal downtime
  • Have robust data backup mechanisms to prevent data loss

Compatibility

• The application should be compatible with:
  • Mobile devices(Android first, iOS later.)

Maintainability

• The codebase should be:
  • Well-documented
  • Modular
  • Facilitate easy maintenance and updates

Compliance

• The application must comply with relevant financial data protection regulations and standards.(None done yet)

2. Use Case Diagrams

This diagram visually represent interactions between users and the system.

3. User Stories and Scenarios

This(se) diagram(s) is/are to describe features from the user's perspective, including acceptance criteria (e.g., "Add income sources to track finances"). - To be completed soon.

3.1. User Interface

user	Onboarding	Views

4. Entity-Relationship Diagrams (ERD)

This diagram details the database structure (entities, attributes, relationships) for data storage and management. Click here to edit These are a list of the categories for expenditure(budget/expenses) with their descriptions :

• housing: self explanatory
• transportation: self explanatory
• food: self explanatory
• utilitites: gas, water bill, electricity bill, sewage bills, airconditoining, internet expenses and cell phone bills
• insurance: health insurance, homeowners insurance, auto insurance, life insurance
• healthcare: self explanatory
• saving, investing and debt payment
• personal spending: gym membership, clothes and shoes, home decor and furnishings, gift
• recreation and entertainment: concert tickets, sporting events, family activities & vacation, streaming services, restaurant, video games, hobbies
• education: online courses, university(undergrad, grad school)
• miscellaneous

5. Meeting Notes and Communication Logs

- Document meetings, discussions, and communication during requirement gathering for transparency and future reference.  
   - To be added later.

6. Project Plan for Requirement Analysis

- Outlines activities, timelines, resources, risks, and mitigation strategies for the requirement analysis phase. 
    - To be added later.

budgetbuddy's Issues

delete expenditure

to add a route that will handle delete requests for both budget and expenses from authorized users

Get income for user

Add User Income

Updating user expenditures

Connect to neon database

connect the server to the neon database that you're going to be using the for project

create login page

create onboarding screen

For @jake0011 and @EpaphrasSam

Delete user by id

create signup page

Host the backend

Delete User Income

Create database layout and seed users into the database some content

Edit User Income

Send email verification after signup

Create expense for user

Set up hono.js and create first route

Get expenses for the user

Get user data by id

user sign up and sign in route with authentication

Update User information

Add jwt auth middleware to deleting user

Create middleware for jet auth before protected routes

create HomePage/Dashboard

build bottom navigation of the dashboard UI