mirror of
https://github.com/we-promise/sure.git
synced 2026-04-07 14:31:25 +00:00
116 lines
5.2 KiB
Markdown
116 lines
5.2 KiB
Markdown
[](https://deepwiki.com/we-promise/sure)
|
||
[](https://oss.skylight.io/app/applications/s6PEZSKwcklL)
|
||
[](https://app.dosu.dev/a72bdcfd-15f5-4edc-bd85-ea0daa6c3adc/ask)
|
||
|
||
<img width="1270" height="1140" alt="sure_shot" src="https://github.com/user-attachments/assets/9c6e03cc-3490-40ab-9a68-52e042c51293" />
|
||
|
||
<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>
|
||
|
||
# Sure: The personal finance app for everyone
|
||
|
||
<b>Get
|
||
involved: [Discord](https://discord.gg/36ZGBsxYEK) • [Website](https://sure.am) • [Issues](https://github.com/we-promise/sure/issues)</b>
|
||
|
||
> [!IMPORTANT]
|
||
> This repository is a community fork of the now-abandoned Maybe Finance project. <br />
|
||
> Learn more in their [final release](https://github.com/maybe-finance/maybe/releases/tag/v0.6.0) doc.
|
||
|
||
## Backstory
|
||
|
||
The Maybe Finance team spent most of 2021–2022 building a full-featured personal finance and wealth management app. It even included an “Ask an Advisor” feature that connected users with a real CFP/CFA — all included with your subscription.
|
||
|
||
The business end of things didn't work out, and so they stopped developing the app in mid-2023.
|
||
|
||
After spending nearly $1 million on development (employees, contractors, data providers, infra, etc.), the team open-sourced the app. Their goal was to let users self-host it for free — and eventually launch a hosted version for a small fee.
|
||
|
||
They actually did launch that hosted version … briefly.
|
||
|
||
That also didn’t work out — at least not as a sustainable B2C business — so now here we are: hosting a community-maintained fork to keep the codebase alive and see where this can go next.
|
||
|
||
Join us!
|
||
|
||
## Hosting 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 archived Maybe Finance repo.
|
||
You’re free to fork it under the AGPLv3 license — but we’d love it if you stuck around and contributed here instead.
|
||
|
||
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)
|
||
|
||
## Performance Issues
|
||
|
||
With data-heavy apps, inevitably, there are performance issues. We've set up a public dashboard showing the problematic requests seen on the demo site, along with the stacktraces to help debug them.
|
||
|
||
[https://www.skylight.io/app/applications/s6PEZSKwcklL/recent/6h/endpoints](https://oss.skylight.io/app/applications/s6PEZSKwcklL/recent/6h/endpoints)
|
||
|
||
Any contributions that help improve performance are very much welcome.
|
||
|
||
## Local Development Setup
|
||
|
||
**If you are trying to _self-host_ the app, [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 (latest stable version recommended)
|
||
- Redis > 5.4 (latest stable version recommended)
|
||
|
||
### Getting Started
|
||
```sh
|
||
cd sure
|
||
cp .env.local.example .env.local
|
||
bin/setup
|
||
bin/dev
|
||
|
||
# Optionally, load demo data
|
||
rake demo_data:default
|
||
```
|
||
|
||
Visit http://localhost:3000 to view the app.
|
||
|
||
If you loaded the optional demo data, log in with these credentials:
|
||
|
||
- Email: `user@example.com`
|
||
- Password: `Password1!`
|
||
|
||
For further instructions, see guides below.
|
||
|
||
### Setup Guides
|
||
|
||
- [Mac dev setup](https://github.com/we-promise/sure/wiki/Mac-Dev-Setup-Guide)
|
||
- [Linux dev setup](https://github.com/we-promise/sure/wiki/Linux-Dev-Setup-Guide)
|
||
- [Windows dev setup](https://github.com/we-promise/sure/wiki/Windows-Dev-Setup-Guide)
|
||
- Dev containers - visit [this guide](https://code.visualstudio.com/docs/devcontainers/containers)
|
||
|
||
### One-click
|
||
|
||
[](https://www.pikapods.com/pods?run=sure)
|
||
|
||
[](https://railway.com/deploy/T_draF?referralCode=CW_fPQ)
|
||
|
||
|
||
## License and Trademarks
|
||
|
||
Maybe and Sure are both distributed under
|
||
an [AGPLv3 license](https://github.com/we-promise/sure/blob/main/LICENSE).
|
||
- "Maybe" is a trademark of Maybe Finance, Inc.
|
||
- "Sure" is not, and refers to this community fork.
|