Skip to content

Latest commit

 

History

History
122 lines (96 loc) · 4.95 KB

README.md

File metadata and controls

122 lines (96 loc) · 4.95 KB


Transact

WhyDocumentationHowGet Started

Transact is an application designed to help users track their expenses, income, and overall financial status. It provides a convenient way to categorize and visualize financial data through graphs.

Landing Page

Why Should I use this App?

With this app, users can record their expenses and income, assigning them to specific categories such as groceries, transportation, entertainment, or any other custom categories they define. By categorizing their transactions, users can gain insights into their spending habits and identify areas where they can potentially save money.

In addition to tracking individual expenses and income, the app also calculates the net amount, which represents the difference between the total income and total expenses. This allows users to see their overall financial status at a glance.

One of the key features of the Finance Tracker App is its ability to generate graphs and charts based on the recorded data. These visual representations provide a clear overview of the user's financial situation over time. Users can choose different types of graphs, such as bar charts or pie charts, to visualize their expenses and income in a way that is easy to understand.

By using the Finance Tracker App, users can gain better control over their finances, make informed decisions about their spending, and work towards achieving their financial goals.

The Finance Tracker App lists your income and expenses and posts them as a graph and informatics.

Important Files

transact/
├── docs/
│   ├── conventions/
│   │   ├── coding_conventions.md
│   │   └── best_practices_in_next.md
│   ├── design/
│   │   ├── software_design.md
│   │   ├── database_design.md
│   │   ├── data_design_for_visualizations.md
│   │   └── system_architecture.md
│   ├── discussion/
│   │   └── component_folder_organization.md
│   ├── ...
│   ├── style/
│   │   └── style_guide.md
│   ├── CHANGELOG.md
├── ERD_and_Implementation/
│   ├── diagrams/...
│   ├── Plan.erd
│   ├── Requirements.todo
│   └── ...
├── src/
│   ├── app/
│   └── ...
├── README.md
├── LICENSE
└── ...

Documentation

Core Process

Account, Input, Output

Accounts

Places for income to be stored.

Input

Takes in amounts labeled as either income, savings, or expense, along with its frequency. User can declare if expense is non-essential.

'Income' are sent into accounts. 'Expenses' subtract from accounts.

Output

Compile income, savings, and expense. Turn income, saving, and expense account into a csv and reset 'Income' and 'Expense' accounts. 'Saving' accounts will remain for the next iteration.

Charts income and usage, either arranged by name or category.

Getting Started

This project is an offline-first based app which means you can easily run and use the application with a few commands:

  1. Clone the project by using:
git clone https://github.com/ssanjose/transact.git
# or
git clone (your-forked-repo)
  1. Go to the directory and run the development server:

Note

Go into the folder with cd ./transact

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about the tools used in the app, take a look at the following resources:

Deployment (Coming Soon)

Soon to be deployed with GitHub pages