Readme.md

Accountant

This project is in its very early stages meaning breaking changes are going to be introduced sooner rather than later. You should be prepared for a complete data wipe due to the schema changes since a safe migration process is currently not implemented.

Usage

This project requires a Docker and Docker Compose installation. A script for running it is present in the bin folder. You can familiarize yourself with it by running it with the -h flag.

Please read the Notes bellow before running the app.

Production

Substitute the domains in the nginx/config/app_prod.nginx with your own.

Run these commands:

sudo chmod u+x bin/accountant.sh
# Creates the secrets folder with required credential files.
./bin/accountant.sh secrets --production
# Generates a Let's encrypt certificate.
./bin/accountant.sh cert -d <your.domain> -e <[email protected]>
./bin/accountant.sh up --production
# Runs migrations:
docker exec -it accountant_app bin/console doctrine:migrations:migrate

If you require HTTP Basic Auth, you can set it up with:

# Generates a .htpasswd file.
./bin/accountant.sh secure

You also have to uncomment:

• docker-compose-prod.yml: build arguments and auth volume
• nginx/Dockerfile: the RUN command
• nginx/conf/app_prod.nginx: the auth_basic directives

Development

Add the accountant.test domain to your /etc/hosts file.

sudo chmod u+x bin/accountant.sh
./bin/accountant.sh secrets
./bin/accountant.sh up
# Runs migrations:
docker exec -it accountant_app bin/console doctrine:migrations:migrate

Notes

This application doesn't handle errors gracefully, so be prepared to see some non-formatted error messages.

On that note, a category cannot be removed if it's linked to a transaction or transaction template. In order to remove a category no transaction or transaction template can use it.

You can find your DB credentials in the secrets folder.