https://github.com/searls/fine-ants-app
An app that uses the fine_ants gem to aggregate personal finance data
https://github.com/searls/fine-ants-app
Last synced: 2 months ago
JSON representation
An app that uses the fine_ants gem to aggregate personal finance data
- Host: GitHub
- URL: https://github.com/searls/fine-ants-app
- Owner: searls
- License: gpl-3.0
- Created: 2016-08-07T04:08:52.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T06:25:00.000Z (about 2 years ago)
- Last Synced: 2024-10-19T23:26:36.644Z (7 months ago)
- Language: Ruby
- Size: 258 KB
- Stars: 44
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# fine_ants_app 🐜
This is a little Rails app that uses the
[fine_ants](https://github.com/searls/fine_ants) 🐜 gem to aggregate personal account standings and tally them up by taking snapshots using Capybara (e.g. scraping them with browsers). It's meant to be run locally.
## setup
**This app isn't secured! At all! It's meant to be run locally! Don't go
deploying it to Heroku or Google or the Cloud!**
### requirements
- Ruby 3.2.1
- Bundler 2
- Yarn 1
### install
```
$ git clone [email protected]:searls/fine-ants-app.git # 🐜
$ cd fine-ants-app
$ bin/setup
$ bin/dev
```
That'll get the server going at [http://localhost:3000](http://localhost:3000).
### demo
**Be sure to run this on an empty database to keep from corrupting your data.**
To generate demo data with which to play with the app, run
```
$ bin/rails demo
```
This will add randomized banks, accounts, and snapshot data to your database.
Also, keep in mind that the demo data isn't attached to a supported fine_ants
adapter, and so any attempts to generate fresh snapshots will fail. It's just
there to give you a look at the dashboard with some data in it.
### create stuff
1. Create a bank (e.g. named "Vanguard", adapter "vanguard")
[here](http://localhost:3000/admin/banks/new)
2. Create a user for that 🐜 bank with your user and password
[here](http://localhost:3000/admin/users/new)
3. Head 🐜 back to the [dashboard](http://localhost:3000/) and click
"Update Accounts" to kick off update process. This will save off `Snapshot`
models for each of your accounts
4. After the 🐜 update finishes, your dashboard should tally up your accounts based
on their latest snapshots, giving you the grand total
## secure your data
I secure my data on an encrypted disk image. I do this with Disk Utility:
With the disk image mounted to `/Volumes/fine_ants_data`, I then set up symlinks
to my local databases:
```
$ cd db
$ ln -s /Volumes/fine_ants_data/development.sqlite3 .
$ ln -s /Volumes/fine_ants_data/test.sqlite3 .
```
Then, when starting my app, I start by opening (and decrypting the local disk
image) with:
```
$ open db/data.dmg
# Which will prompt me for the image's password
$ bin/dev
```
Since it's so easy to encrypt your local data in OS X, this is a good enough
safeguard against accidentally sharing your personal financial information when
moving around code and projects, which most people typically think of as safe.