|
1 | 1 |
|
2 | | -<img width="1190" alt="maybe_hero" src="https://github.com/user-attachments/assets/13fc5ef4-ce0f-4073-a163-9dbc3eb4c8e5" /> |
| 2 | +<img width="1190" alt="maybe_hero" src="https://github.com/user-attachments/assets/5ed08763-a9ee-42b2-a436-e05038fcf573" /> |
3 | 3 |
|
4 | 4 | # Maybe: The personal finance app for everyone |
5 | 5 |
|
6 | | -<b>Get |
7 | | -involved: [Discord](https://link.maybe.co/discord) • [Website](https://maybefinance.com) • [Issues](https://github.com/maybe-finance/maybe/issues)</b> |
8 | | - |
9 | | -## Backstory |
10 | | - |
11 | | -We spent the better part of 2021/2022 building a personal finance + wealth |
12 | | -management app called, Maybe. Very full-featured, including an "Ask an Advisor" |
13 | | -feature which connected users with an actual CFP/CFA to help them with their |
14 | | -finances (all included in your subscription). |
15 | | - |
16 | | -The business end of things didn't work out, and so we shut things down mid-2023. |
17 | | - |
18 | | -We spent the better part of $1,000,000 building the app (employees + |
19 | | -contractors, data providers/services, infrastructure, etc.). |
20 | | - |
21 | | -We're now reviving the product as a fully open-source project. The goal is to |
22 | | -let you run the app yourself, for free, and use it to manage your own finances |
23 | | -and eventually offer a hosted version of the app for a small monthly fee. |
| 6 | +> [!IMPORTANT] |
| 7 | +> This repository is no longer actively maintained. You can read more about this in our [final release](https://github.com/user-attachments/assets/5ed08763-a9ee-42b2-a436-e05038fcf573). |
24 | 8 |
|
25 | 9 | ## Maybe Hosting |
26 | 10 |
|
27 | | -There are 2 primary ways to use the Maybe app: |
28 | | - |
29 | | -1. Managed (easiest) - we're in alpha and release invites in our Discord |
30 | | -2. [Self-host with Docker](docs/hosting/docker.md) |
31 | | - |
32 | | -## Contributing |
33 | | - |
34 | | -Before contributing, you'll likely find it helpful |
35 | | -to [understand context and general vision/direction](https://github.com/maybe-finance/maybe/wiki). |
36 | | - |
37 | | -Once you've done that, please visit |
38 | | -our [contributing guide](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md) |
39 | | -to get started! |
40 | | - |
41 | | -### Performance Issues |
42 | | - |
43 | | -With data-heavy apps, inevitably, there are performance issues. We've set up a public dashboard showing the problematic requests, along with the stacktraces to help debug them. |
44 | | - |
45 | | -Any contributions that help improve performance are very much welcome. |
46 | | - |
47 | | -https://oss.skylight.io/app/applications/XDpPIXEX52oi/recent/6h/endpoints |
| 11 | +Maybe is a fully working personal finance app that can be [self hosted with Docker](docs/hosting/docker.md). |
48 | 12 |
|
49 | 13 | ## Local Development Setup |
50 | 14 |
|
@@ -78,25 +42,13 @@ credentials to log in (generated by DB seed): |
78 | 42 |
|
79 | 43 | For further instructions, see guides below. |
80 | 44 |
|
81 | | -### Multi-currency support |
82 | | - |
83 | | -If you'd like multi-currency support, there are a few extra steps to follow. |
84 | | - |
85 | | -1. Sign up for an API key at [Synth](https://synthfinance.com). It's a Maybe |
86 | | - product and the free plan is sufficient for basic multi-currency support. |
87 | | -2. Add your API key to your `.env` file. |
88 | | - |
89 | 45 | ### Setup Guides |
90 | 46 |
|
91 | 47 | - [Mac dev setup guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide) |
92 | 48 | - [Linux dev setup guide](https://github.com/maybe-finance/maybe/wiki/Linux-Dev-Setup-Guide) |
93 | 49 | - [Windows dev setup guide](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide) |
94 | 50 | - Dev containers - visit [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more |
95 | 51 |
|
96 | | -## Repo Activity |
97 | | - |
98 | | - |
99 | | - |
100 | 52 | ## Copyright & license |
101 | 53 |
|
102 | 54 | Maybe is distributed under |
|
0 commit comments