Budget App

Welcome to the official repository of Budget App*, the leading financial tracking application for families in the European market.

Our application aims to empower families to manage their finances with ease and accuracy, offering features such as expense tracking, financial planning, and budgeting. For details on upcoming features, refer to the User Stories in our Asana project.

*Note: "Budget App" is a provisional name. A final name will be chosen with a marketing focus.

Setup

To run the project locally, use Docker and Laravel Sail. Prerequisites are git and Docker. As an alternative to Docker on macOS, we recommend Orbstack.

It is recommended to set up this alias in your system before proceeding with the following steps: alias sail='bash vendor/bin/sail'.

Steps

1. Clone the repository:

   git clone git@github.com:LucaPipolo/budget-app.git && cd budget-app

2. Install Composer dependencies:

   docker run --rm \
   -u "$(id -u):$(id -g)" \
   -v "$(pwd):/var/www/html" \
   -w /var/www/html \
   laravelsail/php84-composer:latest \
   composer install --ignore-platform-reqs```

3. Create .env file:

   cp .env.example .env

4. Start Laravel Sail:

   sail up

5. Generate an app key

   sail php artisan key:generate

6. Install NPM dependencies.

   sail bun install

7. Build assets

   sail bun dev

8. Run migrations and seed the database

   sail php artisan migrate:fresh --seed

How to Contribute

Contributions are welcome!

Read our Code of Conduct and the Contributing guidelines before contributing.

For security vulnerabilities, consult our Security Policy.

License

Licensed under GNU AFFERO GENERAL PUBLIC LICENSE — Copyright (C) 2025 somoscuatro.