A free, open source budgeting tool powered by the Costs to Expect API. This tool is designed to help you budget for your next big purchase, or just to help you keep track of your spending. It’s easy to use, and it’s free!
Check out our site for more information.
Our FAQs, Getting Started and Workflow pages should cover most of your questions, but if you have any, please don't hesitate to contact us.
Our overview is so clear and simple, a child could manage your budget. We wouldn’t recommend it, but you get the idea.
Simply input your income and outgoings to see projected balances and savings for the months and years ahead. Handy, right?
We understand that not all expenses are monthly - we provide the tools to set exclusions, ensuring your budget is completely customisable and up-to-date.
I'm going to assume you are using Docker, if not, you should be able to work out what you need to run for your development setup from the steps below.
Go to the project root directory and run the below commands:
- Set all the relevant ENV variables, copy .env.example, at a minimum you need to set all the
DB_*variables. - I use mailgun, if you use something else, you'll need to change the mail driver in the .env file.
$ `docker network create costs.network` *
$ `docker compose build`
$ `docker compose up`- I typically install all my dependencies through PHPStorm, but you should install then how you normally would.
$ `docker exec costs.budget.app php artisan key:generate`
$ `docker exec costs.budget.app php artisan migrate`*We include a network for local development purposes, I need to connect to a local version of the Costs to Expect API, You probably don't need this so remove the network section from your docker compose file and don't create the network.
We include a suite of tests for the Budget service, run them as below.
$ `docker exec costs.budget.app vendor/bin/phpunit tests/`