Home finance is an app created for manage family accounts, but it can be used for small business too.
It was built with:
This repo is the backend for Home Finance app and it serves Rest APIs.
After download the project, rename the file .env.example to .env and add your database credentials in the variables:
DB_CONNECTION=mysql
DB_HOST=home_finance_db
DB_PORT=3306
DB_DATABASE=home_finance
DB_USERNAME=user
DB_PASSWORD=123
If the network home-finance-network doesn't already exist, you'll need to create it manually. Run the following command:
$ docker network create home-finance-network
Now, you will need docker installed. Run this command to build and up the docker container:
$ docker compose up -d
Great, now the API is available at 127.0.0.1:8080
You can check documentation and test all the endpoints on swagger, available at 127.0.0.1:8080/api/documentation
To test endpoints using authorization, use the Bearer token provided by the api/user/register or api/user/login endpoint.
Find below a screenshot of API documentation
If you need update swagger documentation, you'll need edit the file public/swagger-ui/swagger.json