diff --git a/README.md b/README.md index 18602345..9eb97cfd 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,14 @@ -maybe_hero +maybe_hero # Maybe: The personal finance app for everyone -Get -involved: [Discord](https://link.maybe.co/discord) • [Website](https://maybefinance.com) • [Issues](https://github.com/maybe-finance/maybe/issues) - -## Backstory - -We spent the better part of 2021/2022 building a personal finance + wealth -management app called, Maybe. Very full-featured, including an "Ask an Advisor" -feature which connected users with an actual CFP/CFA to help them with their -finances (all included in your subscription). - -The business end of things didn't work out, and so we shut things down mid-2023. - -We spent the better part of $1,000,000 building the app (employees + -contractors, data providers/services, infrastructure, etc.). - -We're now reviving the product as a fully open-source project. The goal is to -let you run the app yourself, for free, and use it to manage your own finances -and eventually offer a hosted version of the app for a small monthly fee. +> [!IMPORTANT] +> 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). ## Maybe Hosting -There are 2 primary ways to use the Maybe app: - -1. Managed (easiest) - we're in alpha and release invites in our Discord -2. [Self-host with Docker](docs/hosting/docker.md) - -## Contributing - -Before contributing, you'll likely find it helpful -to [understand context and general vision/direction](https://github.com/maybe-finance/maybe/wiki). - -Once you've done that, please visit -our [contributing guide](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md) -to get started! - -### Performance Issues - -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. - -Any contributions that help improve performance are very much welcome. - -https://oss.skylight.io/app/applications/XDpPIXEX52oi/recent/6h/endpoints +Maybe is a fully working personal finance app that can be [self hosted with Docker](docs/hosting/docker.md). ## Local Development Setup @@ -78,14 +42,6 @@ credentials to log in (generated by DB seed): For further instructions, see guides below. -### Multi-currency support - -If you'd like multi-currency support, there are a few extra steps to follow. - -1. Sign up for an API key at [Synth](https://synthfinance.com). It's a Maybe - product and the free plan is sufficient for basic multi-currency support. -2. Add your API key to your `.env` file. - ### Setup Guides - [Mac dev setup guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide) @@ -93,10 +49,6 @@ If you'd like multi-currency support, there are a few extra steps to follow. - [Windows dev setup guide](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide) - Dev containers - visit [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more -## Repo Activity - -![Repo Activity](https://repobeats.axiom.co/api/embed/7866c9790deba0baf63ca1688b209130b306ea4e.svg "Repobeats analytics image") - ## Copyright & license Maybe is distributed under