mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-08-02 12:05:19 +02:00
5aca2ff9b6
* v1 of backend implementation for self hosting * Add docs * Add upgrades controller * Add global helpers for self hosting mode * Add self host settings controller * Conditionally show self hosting settings * Environment and config updates * Complete upgrade prompting flow * Update config for forked repo * Move configuration of github provider within class * Add upgrades cron * Update deploy button * Update guides * Fix render deployer * Typo * Enable auto upgrades * Fix cron * Make upgrade modes more clear and consistent * Trigger new available version * Fix logic for displaying upgrade prompts * Finish implementation * Fix regression * Trigger new version * Add i18n translations * trigger new version * reduce caching time for testing * Decrease cache for testing * trigger upgrade * trigger upgrade * Only trigger deploy once * trigger upgrade * If target is commit, always upgrade if any upgrade is available * trigger upgrade * trigger upgrade * Test release * Change back to maybe repo for defaults * Fix lint errors * Clearer naming * Fix relative link * Add abs path * Relative link * Update docs
102 lines
4.2 KiB
Markdown
102 lines
4.2 KiB
Markdown
<img width="1440" alt="dashboard_mockup" src="https://github.com/maybe-finance/maybe/assets/35243/a7763d0e-a942-42db-bde7-eb8d28106917">
|
|
<sup><i>(Note: The image above is a mockup of what we're working towards. We're rapidly approaching the functionality shown, but not all of the parts are ready just yet.)</i></sup>
|
|
|
|
# Maybe: The OS for your personal finances
|
|
|
|
<b>Get involved: [Discord](https://link.maybe.co/discord) • [Website](https://maybe.co) • [Issues](https://github.com/maybe-finance/maybe/issues)</b>
|
|
|
|
_If you're looking for the previous React codebase, you can find it at [maybe-finance/maybe-archive](https://github.com/maybe-finance/maybe-archive)._
|
|
|
|
## 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.
|
|
|
|
## Self Hosting
|
|
|
|
You can find [detailed setup guides for self hosting here](docs/self-hosting.md).
|
|
|
|
### One-Click Render deploy (recommended)
|
|
|
|
<a href="https://render.com/deploy?repo=https://github.com/maybe-finance/maybe">
|
|
<img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Render" />
|
|
</a>
|
|
|
|
1. Click the button above
|
|
2. Follow the instructions in the [Render self-hosting guide](docs/self-hosting/render.md)
|
|
|
|
## Local Development Setup
|
|
|
|
### Requirements
|
|
|
|
- Ruby >3 (see `Gemfile`)
|
|
- PostgreSQL >9.3 (ideally, latest stable version)
|
|
|
|
After cloning the repo, the basic setup commands are:
|
|
|
|
```sh
|
|
cd maybe
|
|
cp .env.example .env
|
|
bin/setup
|
|
bin/dev
|
|
|
|
# Optionally, load demo data
|
|
rake demo_data:reset
|
|
```
|
|
|
|
And visit http://localhost:3000 to see the app. You can use the following credentials to log in (generated by DB seed):
|
|
|
|
- Email: `user@maybe.local`
|
|
- Password: `password`
|
|
|
|
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
|
|
|
|
#### Dev Container (optional)
|
|
|
|
This is 100% optional and meant for devs who don't want to worry about installing requirements manually for their platform. You can follow [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more about Dev Containers.
|
|
|
|
If you run into `could not connect to server` errors, you may need to change your `.env`'s `DB_HOST` environment variable value to `db` to point to the Postgres container.
|
|
|
|
#### Mac
|
|
|
|
Please visit our [Mac dev setup guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide).
|
|
|
|
#### Linux
|
|
|
|
Please visit our [Linux dev setup guide](https://github.com/maybe-finance/maybe/wiki/Linux-Dev-Setup-Guide).
|
|
|
|
#### Windows
|
|
|
|
Please visit our [Windows dev setup guide](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide).
|
|
|
|
### Testing Emails
|
|
|
|
In development, we use `letter_opener` to automatically open emails in your browser. When an email sends locally, a new browser tab will open with a preview.
|
|
|
|
## 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!
|
|
|
|
## Repo Activity
|
|
|
|
|
|
|
|
## Copyright & license
|
|
|
|
Maybe is distributed under an [AGPLv3 license](https://github.com/maybe-finance/maybe/blob/main/LICENSE). "Maybe" is a trademark of Maybe Finance, Inc.
|