mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-18 20:59:39 +02:00
Improve self hosting docs (#732)
This commit is contained in:
Zach Gollwitzer
GitHub
parent
fac995b87e
commit
2aee8e3027
6 changed files with 203 additions and 158 deletions
76
README.md
76
README.md
|
|
@ -3,36 +3,35 @@
|
|||
|
||||
# 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>
|
||||
<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)._
|
||||
_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).
|
||||
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 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.
|
||||
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
|
||||
## Maybe Hosting
|
||||
|
||||
You can find [detailed setup guides for self hosting here](docs/self-hosting.md).
|
||||
There are 3 primary ways to use the Maybe app:
|
||||
|
||||
### 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)
|
||||
|
||||
### Docker
|
||||
|
||||
To host Maybe with Docker Compose, please follow our [Docker self-hosting guide](docs/self-hosting/docker.md).
|
||||
1. Managed (easiest) - _coming soon..._
|
||||
2. [One-click deploy](docs/hosting/one-click-deploy.md)
|
||||
3. [Self-host with Docker](docs/hosting/docker.md)
|
||||
|
||||
## Local Development Setup
|
||||
|
||||
|
|
@ -53,7 +52,8 @@ bin/dev
|
|||
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):
|
||||
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`
|
||||
|
|
@ -64,38 +64,52 @@ For further instructions, see guides below.
|
|||
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
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).
|
||||
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).
|
||||
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).
|
||||
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.
|
||||
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).
|
||||
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!
|
||||
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
|
||||
|
||||
|
|
@ -103,4 +117,6 @@ Once you've done that, please visit our [contributing guide](https://github.com/
|
|||
|
||||
## 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.
|
||||
Maybe is distributed under
|
||||
an [AGPLv3 license](https://github.com/maybe-finance/maybe/blob/main/LICENSE). "
|
||||
Maybe" is a trademark of Maybe Finance, Inc.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue