A family-friendly way to manage your money and stay on top of your budget.
Because the codebase for Fresh Budget is open-source, you can see exactly how your infomation is being used. Additionally, you could even contribute and help shape the platform.
- Standard Laravel Requirements
- Composer
- PHP 8.1+
- MySQL 8+
- Node (if working on frontend assets)
git clone https://github.com/freshbudget/freshbudget.git freshbudget
composer install
yarn install
freshbudgetapp
freshbudgetapp_testing
(local only, for automated tests)
cp .env.example .env
php artisan key:generate
php artisan migrate
We are currently using subdomains for the authentication and application routes. You should configure your local etc\hosts
file to point api.domain.test
, app.domain.test
and domain.test
to this application.
We use Pest PHP for the test suite, please ensure before pushing changes you confirm there are no breaking changes by running the command below. Additionally, tests for new features are highly encouraged, changes will be considered without tests but it will increase the time to accept / merge.
php artisan test
We use Laravel Pint to automatically standardize code styling, before pushing changes please run pint using the command below.
./vendor/bin/pint
$FORGE_PHP artisan down --refresh=30
$FORGE_PHP artisan storage:link
$FORGE_PHP artisan migrate --force
$FORGE_PHP artisan optimize:clear
$FORGE_PHP artisan responsecache:clear
$FORGE_PHP artisan icons:clear
$FORGE_PHP artisan optimize
$FORGE_PHP artisan icons:cache
$FORGE_PHP artisan up