BalanceCat

BalanceCat: Your Personal Double Entry Bookkeeping Simplified

Introduction

BalanceCat is an accounting-tool aiming to provide an ease-to-use double entry booking service for normal users. With BalanceCat, users can record journal entries, generate financial reports, make insightful analyses, etc.

Get Started

Environment settings

This project use AWS RDS as database, then the host will looks like this YOUR_DB_NAME.SEEDS.us-east-1.rds.amazonaws.com, you can also using mysql docker container, then the host will be the container name balanceCat_mysql, and you might want to replace MYSQL_RANDOM_ROOT_PASSWORD with MYSQL_ROOT_PAWWSORD in docker-compose.yml.

.env template

# jwt
secretKey = "YOUR_SECRET_KEY"

# mysql
MYSQL_HOST = "YOUR_MYSQL_HOST"  # AWS_RWS_HOST or balanceCat_redis
MYSQL_USER = "YOUR_MYSQL_USER"  
MYSQL_PASSWORD = "YOUR_MYSQL_PASSWORD"
MYSQL_DATABASE = "balanceCat"

# redis
REDIS_HOST = "balanceCat_redis"

Run in docker

docker-compose up --build -d

After the containers are up, you must init the database by posting the API: https://<host>/api/1.0/db/init first in order to run other APIs properly.