mirror of
https://github.com/we-promise/sure.git
synced 2026-04-07 22:34:47 +00:00
2458fa90c8
* point links to wiki & LICENSE * repair final release link * repair old licensing reference
106 lines
4.4 KiB
Markdown
106 lines
4.4 KiB
Markdown
|
||
<img width="1190" alt="maybe_hero" src="https://github.com/user-attachments/assets/5ed08763-a9ee-42b2-a436-e05038fcf573" />
|
||
|
||
<p align="center">
|
||
<!-- Keep these links. Translations will automatically update with the README. -->
|
||
<a href="https://readme-i18n.com/de/we-promise/sure">Deutsch</a> |
|
||
<a href="https://readme-i18n.com/es/we-promise/sure">Español</a> |
|
||
<a href="https://readme-i18n.com/fr/we-promise/sure">Français</a> |
|
||
<a href="https://readme-i18n.com/ja/we-promise/sure">日本語</a> |
|
||
<a href="https://readme-i18n.com/ko/we-promise/sure">한국어</a> |
|
||
<a href="https://readme-i18n.com/pt/we-promise/sure">Português</a> |
|
||
<a href="https://readme-i18n.com/ru/we-promise/sure">Русский</a> |
|
||
<a href="https://readme-i18n.com/zh/we-promise/sure">中文</a>
|
||
</p>
|
||
|
||
# ~Maybe~Sure: The personal finance app for everyone
|
||
|
||
<b>Get
|
||
involved: [Discord](https://discord.gg/36ZGBsxYEK) • [(archived) Website](https://web.archive.org/web/20250715182050/https://maybefinance.com/) • [Issues](https://github.com/we-promise/sure/issues)</b>
|
||
|
||
> [!IMPORTANT]
|
||
> This repository is a community fork of the official (now abandoned) Maybe Finance one.
|
||
> You can read more about this in their [final release](https://github.com/maybe-finance/maybe/releases/tag/v0.6.0) doc.
|
||
|
||
## Backstory
|
||
|
||
The Maybe Finance team 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 they shut things down mid-2023.
|
||
|
||
Having spent the better part of $1,000,000 building the app (employees +
|
||
contractors, data providers/services, infrastructure, etc.) they decided to
|
||
revive the product as a fully open-source project. The goal was 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.
|
||
|
||
Which they did. Offer a hosted version for a short while.
|
||
|
||
That didn't work either (well, the "making it a sustainable B2C business" part
|
||
didn't) so here we are hosting a community maintained fork hoping to keep the
|
||
codebase alive and who knows what else will come next.
|
||
|
||
Join us?
|
||
|
||
## Hosting ~Maybe~Sure
|
||
|
||
Sure is a fully working personal finance app that can be [self hosted with Docker](docs/hosting/docker.md).
|
||
|
||
## Forking and Attribution
|
||
|
||
This repo is a community fork of the no longer maintained Maybe Finance one.
|
||
You’re free to fork it under the AGPLv3 but we prefer if you stay here and contribute.
|
||
To stay compliant and avoid trademark issues:
|
||
|
||
- Be sure to include the original [AGPLv3 license](https://github.com/maybe-finance/maybe/blob/main/LICENSE) and clearly state in your README that your fork is based on Maybe Finance but is **not affiliated with or endorsed by** Maybe Finance Inc.
|
||
- "Maybe" is a trademark of Maybe Finance Inc. and therefore, use of it is NOT allowed in forked repositories (or the logo)
|
||
|
||
## Local Development Setup
|
||
|
||
**If you are trying to _self-host_ the Maybe app, stop here. You
|
||
should [read this guide to get started](docs/hosting/docker.md).**
|
||
|
||
The instructions below are for developers to get started with contributing to the app.
|
||
|
||
### Requirements
|
||
|
||
- See `.ruby-version` file for required Ruby version
|
||
- PostgreSQL >9.3 (ideally, latest stable version)
|
||
|
||
After cloning the repo, the basic setup commands are:
|
||
|
||
```sh
|
||
cd sure
|
||
cp .env.local.example .env.local
|
||
bin/setup
|
||
bin/dev
|
||
|
||
# Optionally, load demo data
|
||
rake demo_data:default
|
||
```
|
||
|
||
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.
|
||
|
||
### Setup Guides
|
||
|
||
- [Mac dev setup guide](https://github.com/we-promise/sure/wiki/Mac-Dev-Setup-Guide)
|
||
- [Linux dev setup guide](https://github.com/we-promise/sure/wiki/Linux-Dev-Setup-Guide)
|
||
- [Windows dev setup guide](https://github.com/we-promise/sure/wiki/Windows-Dev-Setup-Guide)
|
||
- Dev containers - visit [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more
|
||
|
||
## Copyright & license
|
||
|
||
Maybe/Sure are distributed under
|
||
an [AGPLv3 license](https://github.com/we-promise/sure/blob/main/LICENSE).
|
||
Remember that "Maybe" is a trademark of Maybe Finance, Inc.
|
||
"Sure" is not.
|