omarchehab98 / autobank Goto Github PK

View Code? Open in Web Editor NEW

11.0 3.0 3.0 603 KB

Automated expense tracker by parsing bank emails

License: MIT License

JavaScript 98.62% HTML 0.94% CSS 0.45%

expense expenses automated tracker

autobank's Introduction

Autobank by Omar Chehab

automatically logs expenses by monitoring mail
provides weekly and monthly cash flow of expenses and income
authentication using a secret key (uses Storage API to store token locally)

Installation

Node

git clone https://github.com/omarchehab98/autobank
cd eun
npm install

# development
# run both in seperate terminals
npm run dev-client
npm run dev-server

# production
npm run build
npm start

Docker

git clone https://github.com/omarchehab98/autobank
cd eun
docker-compose up

Development

Prerequisites

If you are planning to develop a feature or fix a bug, you should be familiar with the stack.

Client
- web browser
- react
- material-ui
Server
- node
- express
- mongoose
- imap

Hot Reloading

npm run dev-client Watches the client directory, keeps browser in sync with new changes.
npm run dev-server Watches the server directory, restarts server when changes are made.

When submitting a merge request, it must pass all three commands below.

npm run build
npm run lint
npm test

License

MIT © Omar Chehab

autobank's People

Contributors

Stargazers

Watchers

Forkers

jonathol prime9 abdillah

autobank's Issues

Work around building client on travis without including environment.js in public repo

#14

Build failing because environment.js is in gitignore.

Detect inter-account transfers

When a user has multiple accounts and the user transfers money from one account to another, the bar graphs and piecharts get skewed because the software doesn't know it's an inter-account transfer
so it shows them as expenses and incomes.

Modify the software so that inter-account transfers are automatically detected. So, expense and income documents will be tagged as an one.

On the frontend, the pie-charts and bar-graphs should not graph inter-account transfers.

Pie chart too small on mobile when there are lots of categories

Add a toolbar to filter cards by date, category, and name

Add a in ExpensesPage.js with controls that allow filtering cards by timestamp, category, and searching by fuzzy matching description.

Don't worry about design, as long as you use material-ui components, it should look great 🌟

Maintaining an array's sort by timestamp after editing a card's timestamp

When an expense is edited, the expenses array needs to maintain it's sort by timestamp descending.

Currently, I approach this issue in a very naive way by calling .sort(byTimestamp) ExpensesPage.js#L53.

Terrible efficiency aside, Javascript's Array.prototype.sort is

not necessarily stable

(Source)

Optimally, this issue can be resolved by not involving sorting at all.

When a card A's timestamp is modified, slice it out of the array and insert in between two adjacent elements B and C where A.timestamp <= B.timestamp and A.timestamp >= C.timestamp

Automatic expense tracking through email monitoring, add a filter for your bank's email notifications

Does your bank send email notifications of transactions? I bank with Royal Bank of Canada (RBC), I enabled email notifications for every transaction.

I wrote four filters (src/server/mail/filters/rbc.js) that parse the different emails that RBC can send.

Classification of emails is achieved through a functional filtering API (docs/filter.md), using the field set filter (docs/filters/fieldset.md).

An example of the filter that detects RBC's emails is documented in (docs/filters/rbc.md).

Write a filter that classifies your bank's email notifications.

Write unit tests similar to (test/mail/unit/filter-rbc.js) to ensure your code works as expected.

Style doughnut chart tooltips

Show currency and restyle to make it blend into material design theme.

Manual creation of expense and income

Currently, expense and income documents are created only when an email is read.

Add the ability to manually create expense and income transactions using the UI.

I imagine adding a material-ui/FloatingActionButton

When it is clicked, user is prompted for the following information in a Modal Dialog material-ui/dialog:

Income or Expense?
Amount
Currency
Description
Time
Account
Category