|
1 | | -<h4 align="center"><img width="200" src="./src/static/logo.png" alt="Mintable"><h4 align="center">Roll your own ad-free Mint clone for managing personal finances using publicly available APIs.</h4><br></h4> |
| 1 | +<h4 align="center"><img width="100" src="./docs/img/icon.png" alt="Mintable"></h4> |
| 2 | +<h1 align="center" style="font-weight: 500; font-size: 60px !important; border-bottom: 0 !important;">Mintable</h1> |
2 | 3 |
|
3 | | -[](https://travis-ci.com/kevinschaich/mintable) |
4 | | -[](https://github.com/kevinschaich/mintable/releases) |
5 | | -[](https://github.com/kevinschaich/mintable/blob/master/LICENSE) |
6 | | -[](https://github.com/kevinschaich/mintable/graphs/contributors) |
7 | | -[](https://github.com/kevinschaich/mintable/issues) |
8 | | -[](https://github.com/kevinschaich/mintable/pulls) |
9 | | -[](https://reddit.com/r/Mintable) |
| 4 | +<h4 align="center">Automate your personal finances – for free, with no ads, and no data collection.</h4> |
10 | 5 |
|
11 | | -## Quickstart |
| 6 | +<br> |
12 | 7 |
|
13 | | -**Prerequisites:** `node` (tested `v11.6.0`), `yarn` (tested `v1.10.0`) |
| 8 | +Mintable helps you: |
14 | 9 |
|
15 | | -1. If you plan on using Plaid to fetch account data, [sign up](https://dashboard.plaid.com/signup) for an account and [apply for the development plan](https://plaid.com/pricing/). It usually takes them 1-2 business days to approve this request. |
16 | | -2. Link your accounts and a spreadsheet to Mintable. Run these commands to walk through the setup: |
| 10 | +- Keep track of your account balances |
| 11 | +- Aggregate transactions from all your banking institutions, including checking accounts, savings accounts, and credit cards |
| 12 | +- Analyze and budget your spending using a spreadsheet and formulas |
17 | 13 |
|
18 | | -```bash |
19 | | -git clone https://github.com/kevinschaich/mintable.git |
20 | | -cd mintable |
21 | | -yarn |
22 | | -yarn setup |
23 | | -``` |
| 14 | + |
24 | 15 |
|
25 | | -3. After completing the setup, run the following at any time to populate updated data into your spreadsheet: |
| 16 | +<br> |
26 | 17 |
|
27 | | -``` |
28 | | -yarn mintable |
29 | | -``` |
| 18 | +[](https://travis-ci.com/kevinschaich/mintable) |
| 19 | +[](https://github.com/kevinschaich/mintable/releases) |
| 20 | +[](https://github.com/kevinschaich/mintable/blob/master/LICENSE) |
| 21 | +[](https://github.com/kevinschaich/mintable/issues) |
| 22 | +[](https://github.com/kevinschaich/mintable/pulls) |
| 23 | +[](https://reddit.com/r/Mintable) |
30 | 24 |
|
31 | | -> **Note**: If you started using Mintable before `v1.0.0`, you can run `yarn migrate` to migrate to the new web-based configuration framework. |
| 25 | +--- |
32 | 26 |
|
33 | | -## Overview |
| 27 | +## Quickstart |
34 | 28 |
|
35 | | - |
| 29 | +1. Sign up for [Plaid's Free Plan](https://plaid.com/pricing/). |
| 30 | +2. Install Mintable: |
36 | 31 |
|
37 | | -Mintable simplifies managing your finances, for free, without ads, and without tracking your information. Here's how it works: |
| 32 | + ```bash |
| 33 | + npm install -g mintable |
| 34 | + mintable setup |
| 35 | + ``` |
38 | 36 |
|
39 | | -1. You connect your accounts and a spreadsheet to Mintable. |
40 | | -1. Mintable integrates with financial institutions to automatically populate transactions in your spreadsheet. |
41 | | -1. You can add whatever formulas, charts, or calculations you want (just like a normal spreadsheet). We also have templates to get you started. |
| 37 | +3. Update your account balances/transactions: |
42 | 38 |
|
43 | | -## Features |
| 39 | + ``` |
| 40 | + mintable fetch |
| 41 | + ``` |
44 | 42 |
|
45 | | -- Locally hosted, open-source, 100% free, ad-free, no personal data tracking, no data stored by Mintable on central servers |
46 | | -- Integrates with your financial institutions for fully-automated spreadsheet updates |
47 | | -- Web based setup wizard and configuration framework: |
| 43 | +> **Note:** If you're already a version `1.x.x` user, you can [migrate your existing configuration to version `2.x.x`](./docs/README.md#migrating-from-v1xx). |
48 | 44 |
|
49 | | - |
| 45 | +## Documentation |
50 | 46 |
|
51 | | -You can see a full list of options in the **[Config Docs](./docs/CONFIG.md)**. |
| 47 | +Check out the full documentation [in the `./docs` folder](./docs/README.md). |
52 | 48 |
|
53 | 49 | ## FAQs |
54 | 50 |
|
55 | | -**It's not working / I'm having trouble / I need help** |
| 51 | +**WTF is 'Mintable'?!** |
56 | 52 |
|
57 | | -- [File an issue](https://github.com/kevinschaich/mintable/issues) or reach out on our [Reddit community](https://www.reddit.com/r/Mintable/). |
| 53 | +> **min·ta·ble**: _noun._ |
| 54 | +> 1. An open-source tool to automate your personal finances – for free, with no ads, and no data collection. Derived from *mint* (the [wildly popular personal finance app from Intuit](https://www.mint.com/)) + *table* (a spreadsheet). |
58 | 55 |
|
59 | | -**How is this different from [build-your-own-mint](https://github.com/yyx990803/build-your-own-mint)?** |
| 56 | +**Do I have to use Plaid?** |
60 | 57 |
|
61 | | -- **[build-your-own-mint](https://github.com/yyx990803/build-your-own-mint)** is a set of scripts which solely facilitates the integration between Plaid and Google Sheets. It makes no assumptions about what you want your spreadsheet to look like, and you have to define your own logic to map transactions to spreadsheet updates. |
62 | | -- **[Mintable](#)** is and end-to-end system that works out of the box. It comes with a setup wizard, a web-based configuration server, [pluggable providers](./docs/PROVIDERS.md) (you're not limited to just Plaid & Google Sheets), and a spreadsheet template. |
| 58 | +Nope. You can [import transactions from a CSV bank statement](./docs/README.md#manually--on-your-local-machine--via-csv-bank-statements) exclusively on your local machine. We also have [templates](./docs/templates) to get you started. |
63 | 59 |
|
64 | | -**Do I have to give my data to Plaid and Google? Are there any completely self-hosted alternatives I can use?** |
| 60 | +**Do I have to use Google Sheets?** |
65 | 61 |
|
66 | | -- It's [pluggable](./docs/PROVIDERS.md)! Plaid & Google Sheets are working right now – contributions are welcome for [other providers](./docs/PROVIDERS.md)! |
| 62 | +Nope. You can [export your account balances & transactions to a CSV file](./docs/README.md#on-your-local-machine--via-csv-files) exclusively on your local machine. |
67 | 63 |
|
68 | 64 | **Do I have to manually run this every time I want new transactions in my spreadsheet?** |
69 | 65 |
|
70 | | -- You can **[Automate Updates with a CI Provider](./docs/CONFIG.md#automate-updates-with-a-ci-provider)** to get free, automated updates! |
| 66 | +Nope. You can automate it for free using [BitBar](./docs/README.md#automatically-in-your-macs-menu-bar--via-bitbar), [`cron`](./docs/README.md#automatically-in-your-local-machines-terminal--via-cron), or [GitHub Actions](./docs/README#automatically-in-the-cloud--via-github-actions). |
| 67 | +
|
| 68 | +**It's not working!** |
| 69 | + |
| 70 | +- [File an issue](https://github.com/kevinschaich/mintable/issues) or [](https://reddit.com/r/Mintable). |
71 | 71 |
|
72 | | -## Credits |
| 72 | +## Alternatives |
73 | 73 |
|
74 | | -Mintable initially started as a fork of [Evan You](https://github.com/yyx990803)'s [build-your-own-mint](https://github.com/yyx990803/build-your-own-mint). |
| 74 | +- [**Money in Excel**](https://www.microsoft.com/en-us/microsoft-365/blog/2020/06/15/introducing-money-excel-easier-manage-finances/): Recently announced partnership between Microsoft/Plaid. Requires a Microsoft 365 subscription ($70+/year). |
| 75 | +- [**Mint**](https://www.mint.com/): Owned by Intuit (TurboTax). Apps for iOS/Android/Web. |
| 76 | +- [**build-your-own-mint**](https://github.com/yyx990803/build-your-own-mint): Some assembly required. More flexible. |
0 commit comments