Project SpendSmart

Project members:

1. Annie Sorkin (xretr0)
2. Liangyu Han (lxyhan)
3. Anthony Zhao (anthonyzhao27)
4. Ysajelle Yi Ru Chua Lim (Ysajelle-Lim)
5. Jia Yi Wu (Observer3510)

Description

This project was made as the final project for CSC207 at the University of Toronto.

SpendSmart allows you to sign up with a username and password, and log your spendings. You can view what you've logged as well as ask an AI assistant preset questions for help with budgeting.

Table of Contents

• Installation Instructions
• Usage
• License
• Feedback
• Contributions
• User Stories and Use Cases

Installation Instructions

No need to install anything, simply go to the website linked here.

Usage

First, go to the website and click Get Started.

Alternative route - run locally.

If the website is down or not working properly, feel free to run the following commands to set up a local version of the project:

1. Set up the maven back end:

cd backend
mvn clean install
mvn spring-boot:run

2. In another terminal instance run the front end:

cd frontend
npm install
npm run dev

3. Go to the website instance and use the app

Go to http://localhost:5173/

Sign up

Make a new account by entering your email and password.

Sign in

Click Sign in near the bottom of the screen, and sign in with your username and password.

Log an Expense

Click the Add Expense button under the monthly overview on the right. Select a date and category that the expense falls under. Enter the name and amount of the expense and click Save.

Log an Income

Click the Add Income button next to the Add Expense button. Select a date and type that the income falls under. Enter the name and amount of the income and click Save.

See List of Monthly Income & Expenses

Scroll down to see your Spending History. Click the tabs underneath the heading to switch between expenses and income. Scroll down the sidebar to see the filters for each category.

Ask Questions to AI Assistant

Click on the AI Advisor button in the sidebar. Select the kind of advice you'd like from the dropdown of AI advisors. Click on one of the preset questions.

License

Refer to the Creative Commons license here.

Feedback

Send a message in the development discord server's general channel.

Invite with temporary membership here. (Expires December 6, 2024)

What to Report

• Website breaking bugs
• Bugs with the usages listed above
• Issues with navigating the website

What to Expect

Since this project is for school, we will likely not respond to any requests for new features at all or to any bug reports past the due date (December 2, 2024).

Contributions

How to contribute

Contributors should make a new branch to push their changes and additions from. Push requests from the main branch will automatically be rejected.

Reviewing contributions

• Make sure each class and function has a javadoc explaining what it is, does, and what its parameters are.
• Make sure naming conventions are consistent across classes.
• Check that the code's logic makes sense
• Check for redundant imports

User Stories and Use Cases

Team story

As a young adult, I want to keep track of my budgeting so that I can have a better understanding of my finances.

Use Cases:

1. Log in
   1. Enter username & password into respective fields.
   2. Click "login" button
2. Input data
   1. Click "Input" button
3. Input income/expense
   1. Click "Income" button
4. Input income
   1. Select type of income from dropdown
   2. Input date as MMYY format
   3. Click "Submit" button

James' Story

As a student, James wants to learn more about financial products and how to build positive spending and investment habits.

Use Cases:

1. Sign up
   1. Enter a username an password into the signup page
   2. Click the signup button
2. Log in
   1. Enter username and password into the login page
   2. Click the login button
3. Talking with AI financial advisor
   1. Click the start conversation with AI advisor button
   2. Select a message from the given prompts

Jia Yi's Story

As a student in midterm season, Clair wants to track how much she spent on food deliveries so she can see whether she's spent too much.

Use Cases:

1. Log in
   1. Enter username & password into respective fields.
   2. Click "login" button
2. Entering Expenses
   1. Select occurrence of expense from dropdown ("Single time" or "Monthly")
   2. Input the date (format: "MMYY") the expense occurred or started.
   3. Input the amount.
   4. Choose a category for the expense from a dropdown.
3. See List
   1. Click "View Data" button
   2. Select the current month
   3. Look at the records

Anthony's Story

As someone with limited financial resources, I want to monitor my total expenses for a month, so that I can avoid overspending.

Use Cases:

1. Sign up
   1. Enter a username and password into respective fields
   2. Click sign up button
2. Log in
   1. Enter username and password into respective fields
   2. Click login button
3. Viewing expenses
   1. Click " Data" button
4. Visualize expenses
   1. Select the desired month
   2. Click "Visualize" button
5. View the total amount of money spent for the month

Ysajelle’s story

As a Netflix user, I would like to track my monthly subscription and save it in a category, so that I don't need to add it every month.

Use Cases:

1. Sign in
   1. Enter username and password into respective fields
   2. Click the "Sign Up" button
2. Login
   1. Enter username and password into respective fields
   2. Click the "Log In" button
3. Go to input expense window
   1. Click the "Input" button
   2. Click the "Expense" button
4. Input expense
   1. Select occurrence of expense from dropdown ("Single time" or "Monthly")
   2. Input the date(format: "MMYY") the expense occurred or started.
   3. Input the amount.
   4. Choose a category for the expense from a dropdown.
5. Submit Expense
   1. Click "Submit button"
   2. An "expense added" message will pop up beside the "Submit" button.

Annie's Story

As a person with a salary I would like it to appear in each month so that I don’t spend time inputting it every time.

Use cases:

1. Signin
   1. Input the username and password into the appropriate fields
   2. Press the "Sing In" button
2. Login
   1. Input the username and password into the appropriate fields
   2. Press the "Log In" button
3. Adding the income data with the income type
   1. Click the "Add data" button
   2. Choose the "Add Income" button
   3. Input the fields:
      1. Type of income (dropdown "Single time" or "Monthly")
      2. Date
      3. Amount
   4. Press the Submit button
4. Visualize the income data with the income type
   1. Click the "View Data" button
   2. Select the desired month
   3. View the records of income with amount and type listed