Hello and welcome to BFlow!! BFlow (Budget Flow) is an open-source expense & budget tracking backend built with Spring Boot, PostgreSQL (Supabase for deploy) and Redis, designed with clean domain-driven structure and real-world business rules. Its a personal tool to help you out to manage your expenses.
-
Open Docker Desktop during the process, this is important.
-
Open VSCode and open the project folder
-
A notification will appear on the corner
-
Click on the "Reopen in Container" option, then wait until everything is setup. (Around 7-10 min in the first time)
-
In the process there will be a pop-up asking for your WakaTime Api Key (This is a tool that I personally use, if you dont use it just click 'Enter' and nothing will happend). If you want to use WakaTime too you can add it to your dashboards here
-
Watch the containers in Docker Desktop, everyone has to run. (The status is now green on docker)
-
Once everything is downloaded you can run the application with the following command:
./mvnw spring-boot:runTry this first:
- Close all VSCode windows and Docker Desktop,
- Reopen Docker Desktop first and then VSCode
- Open the folder project
- Click on the notification
- Wait again and see if the containers are running on Docker Desktop
If that didnt work usually is because Docker sometimes requires you to restart your machine and try the steps I wrote before.
- You can run "echo $ENV_VAR" (Example: "echo $DB_URL") to display how the container reads the variable.
- If there is an older value press F1 or CTRL + SHIFT + P and run "Dev Containers: Rebuild Container"
- Run "echo $ENV_VAR" again before run the app and now you can see if it reads the value you changed