From a26a138b0c9c618b9e4cf00b4dd860b01dc6d234 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Jos=C3=A9=20Mata?= Date: Mon, 28 Jul 2025 08:35:56 +0200 Subject: [PATCH 1/4] Another README.md update MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Juan José Mata --- README.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9e12b9f09..fe3b06e53 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,22 @@ maybe_hero +

+ + Deutsch | + Español | + français | + 日本語 | + 한국어 | + Português | + Русский | + 中文 +

+ # ~Maybe~Sure: The personal finance app for everyone Get -involved: [Discord](https://discord.gg/36ZGBsxYEK) • [Website](https://web.archive.org/web/20250715182050/https://maybefinance.com/) • [Issues](https://github.com/we-promise/sure/issues) +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) > [!IMPORTANT] > This repository is a community fork of the official (now abandoned) Maybe Finance one. @@ -33,15 +45,15 @@ codebase alive and who knows what else will come next. Join us? -[^^^ STOPPED EDITING HERE ^^^] +## Hosting ~Maybe~Sure -## Maybe Hosting - -Maybe is a fully working personal finance app that can be [self hosted with Docker](docs/hosting/docker.md). +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 no longer maintained. You’re free to fork it under the AGPLv3. To stay compliant and avoid trademark issues: +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) @@ -61,7 +73,7 @@ The instructions below are for developers to get started with contributing to th After cloning the repo, the basic setup commands are: ```sh -cd maybe +cd sure cp .env.local.example .env.local bin/setup bin/dev @@ -87,6 +99,7 @@ For further instructions, see guides below. ## 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/Sure are distributed under +an [AGPLv3 license](https://github.com/maybe-finance/maybe/blob/main/LICENSE). +Remember that "Maybe" is a trademark of Maybe Finance, Inc. +"Sure" is not. From be65fc5845a1d14890438e78deade95284e7e075 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Jos=C3=A9=20Mata?= Date: Mon, 28 Jul 2025 08:38:12 +0200 Subject: [PATCH 2/4] Capitalization matters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Juan José Mata --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fe3b06e53..f13490a4b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Deutsch | Español | - français | + Français | 日本語 | 한국어 | Português | From 5223d56dc8e0c229e621a0c76ce00039f5891753 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Jos=C3=A9=20Mata?= Date: Tue, 29 Jul 2025 23:11:44 +0200 Subject: [PATCH 3/4] Update docker.md with new naming MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Juan José Mata --- docs/hosting/docker.md | 43 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/hosting/docker.md b/docs/hosting/docker.md index 28ae6b16f..f3683536d 100644 --- a/docs/hosting/docker.md +++ b/docs/hosting/docker.md @@ -1,6 +1,6 @@ -# Self Hosting Maybe with Docker +# Self Hosting Sure with Docker -This guide will help you setup, update, and maintain your self-hosted Maybe application with Docker Compose. Docker Compose is the most popular and recommended way to self-host the Maybe app. +This guide will help you setup, update, and maintain your self-hosted Sure application with Docker Compose. Docker Compose is the most popular and recommended way to self-host the Sure app. ## Setup Guide @@ -27,10 +27,10 @@ Open your terminal and create a directory where your app will run. Below is an e ```bash # Create a directory on your computer for Docker files (name whatever you'd like) -mkdir -p ~/docker-apps/maybe +mkdir -p ~/docker-apps/sure # Once created, navigate your current working directory to the new folder -cd ~/docker-apps/maybe +cd ~/docker-apps/sure ``` #### Copy our sample Docker Compose file @@ -38,8 +38,8 @@ cd ~/docker-apps/maybe Make sure you are in the directory you just created and run the following command: ```bash -# Download the sample compose.yml file from the Maybe Github repository -curl -o compose.yml https://raw.githubusercontent.com/maybe-finance/maybe/main/compose.example.yml +# Download the sample compose.yml file from the GitHub repository +curl -o compose.yml https://raw.githubusercontent.com/we-promise/sure/main/compose.example.yml ``` This command will do the following: @@ -106,7 +106,7 @@ This will pull our official Docker image and start the app. You will see logs in Open your browser, and navigate to `http://localhost:3000`. -If everything is working, you will see the Maybe login screen. +If everything is working, you will see the Sure login screen. ### Step 5: Create your account @@ -117,7 +117,7 @@ The first time you run the app, you will need to register a new account by hitti ### Step 6: Run the app in the background -Most self-hosting users will want the Maybe app to run in the background on their computer so they can access it at all times. To do this, hit `Ctrl+C` to stop the running process, and then run the following command: +Most self-hosting users will want the Sure app to run in the background on their computer so they can access it at all times. To do this, hit `Ctrl+C` to stop the running process, and then run the following command: ```bash docker compose up -d @@ -133,26 +133,25 @@ docker compose ls Your app is now set up. You can visit it at `http://localhost:3000` in your browser. -If you find bugs or have a feature request, be sure to read through our [contributing guide here](https://github.com/maybe-finance/maybe/wiki/How-to-Contribute-Effectively-to-this-Project). +If you find bugs or have a feature request, be sure to read through our [contributing guide here](https://github.com/we-promise/sure/wiki/How-to-Contribute-Effectively-to-this-Project). ## How to update your app The mechanism that updates your self-hosted Maybe app is the GHCR (Github Container Registry) Docker image that you see in the `compose.yml` file: ```yml -image: ghcr.io/maybe-finance/maybe:latest +image: ghcr.io/we-promise/sure:latest ``` -We recommend using one of the following images, but you can pin your app to whatever version you'd like (see [packages](https://github.com/maybe-finance/maybe/pkgs/container/maybe)): +We recommend using one of the following images, but you can pin your app to whatever version you'd like (see [packages](https://github.com/we-promise/sure/pkgs/container/maybe)): -- `ghcr.io/maybe-finance/maybe:latest` (latest commit) -- `ghcr.io/maybe-finance/maybe:stable` (latest release) +- `ghcr.io/we-promise/sure:latest` (latest commit) +- `ghcr.io/we-promise/sure:stable` (latest release) -By default, your app _will -NOT_ automatically update. To update your self-hosted app, run the following commands in your terminal: +By default, your app _will NOT_ automatically update. To update your self-hosted app, run the following commands in your terminal: ```bash -cd ~/docker-apps/maybe # Navigate to whatever directory you configured the app in +cd ~/docker-apps/sure # Navigate to whatever directory you configured the app in docker compose pull # This pulls the "latest" published image from GHCR docker compose build # This rebuilds the app with updates docker compose up --no-deps -d web worker # This restarts the app using the newest version @@ -163,7 +162,7 @@ docker compose up --no-deps -d web worker # This restarts the app using the newe If you'd like to pin the app to a specific version or tag, all you need to do is edit the `compose.yml` file: ```yml -image: ghcr.io/maybe-finance/maybe:stable +image: ghcr.io/we-promise/sure:stable ``` After doing this, make sure and restart the app: @@ -178,17 +177,17 @@ docker compose up --no-deps -d app # This restarts the app using the newest vers ### ActiveRecord::DatabaseConnectionError -If you are trying to get Maybe started for the **first time** and run into database connection issues, it is likely because Docker has already initialized the Postgres database with a _different_ default role (usually from a previous attempt to start the app). +If you are trying to get Sure started for the **first time** and run into database connection issues, it is likely because Docker has already initialized the Postgres database with a _different_ default role (usually from a previous attempt to start the app). If you run into this issue, you can optionally **reset the database**. -**PLEASE NOTE: this will delete any existing data that you have in your Maybe database, so proceed with caution.** For first-time users of the app just trying to get started, you're generally safe to run the commands below. +**PLEASE NOTE: this will delete any existing data that you have in your Sure database, so proceed with caution.** For first-time users of the app just trying to get started, you're generally safe to run the commands below. -By running the commands below, you will delete your existing Maybe database and "reset" it. +By running the commands below, you will delete your existing Sure database and "reset" it. ``` docker compose down -docker volume rm maybe_postgres-data # this is the name of the volume the DB is mounted to +docker volume rm sure_postgres-data # this is the name of the volume the DB is mounted to docker compose up -docker exec -it maybe-postgres-1 psql -U maybe -d maybe_production -c "SELECT 1;" # This will verify that the issue is fixed +docker exec -it sure-postgres-1 psql -U maybe -d maybe_production -c "SELECT 1;" # This will verify that the issue is fixed ``` From 8ecd8dcf8eaefb64986b93f696e64529c63725dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Jos=C3=A9=20Mata?= Date: Thu, 31 Jul 2025 22:47:27 +0200 Subject: [PATCH 4/4] New Wiki page localtion MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Juan José Mata --- docs/hosting/docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/docker.md b/docs/hosting/docker.md index f3683536d..6c568e089 100644 --- a/docs/hosting/docker.md +++ b/docs/hosting/docker.md @@ -133,7 +133,7 @@ docker compose ls Your app is now set up. You can visit it at `http://localhost:3000` in your browser. -If you find bugs or have a feature request, be sure to read through our [contributing guide here](https://github.com/we-promise/sure/wiki/How-to-Contribute-Effectively-to-this-Project). +If you find bugs or have a feature request, be sure to read through our [contributing guide here](https://github.com/we-promise/sure/wiki/How-to-Contribute-Effectively-to-Sure). ## How to update your app