#+TITLE House of Bills

The main idea of the project is to handle all information of your house’s. Income, Bills and other details. The project allow to have scheduled payments or incomes.

Clone application

git clone https://github.com/VlasovArtem/hob

Table of the contents

1. Views
2. Configuration
3. How to start

Views

The application is allow to use it in two ways:

1. API
2. Terminal

Default view is Terminal

Check configuration for more details.

Configuration

The application allow to use the next type of configuration:

1. Yaml configuration
2. Flags

The flags is overrides Yaml configuration.

Yaml

Be default the application will try to find environment variable `HOBCONFIG`. If the variable is not found, then the application try to use XDG.

user:
 # default user authorization for terminal view ONLY. If the configuration is not provided then the app show sign up and sign in feature.
 email: email@mail.com
 # default user password for terminal view ONLY.
 password: 123456
app:
 # Path to the log file. Log file has default value for terminal view
 logfile: /Users/avlasov/org/logs/hob/application.log
 # Log level. Default: info. Possible values: info, debug, warn, error, fatal
 logleve: info
 # Application view. Default: terminal. Possible values: terminal (shorthand - 't'), api (shorthand - 'a')
 view: terminal

Flags

Flags	Values	Description
-f, –log-file		Log file path. Default: Empty for api and temp for terminal.
-l, –log-level	info, debug, warn, error, fatal	Log level. Default: ‘info’
-u, –user-email		Default user email. Only for terminal view
-p, –user-password		Default user password
-v, –view	terminal, t, api, a	Application view

How to start

Make project

make build && make img && make compose-up

Database

docker run --name hob -e POSTGRES_USERNAME=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=hob -d -p 5432:5432 postgres

Database properties is configurable view environment variables:

• DB_HOST - host of a database. Default: localhost
• DB_PORT - post of a database. Default: 5432
• DB_USER - username of a database. Default: postgres
• DB_PASSWORD - password of a database. Default: postgres
• DB_NAME - database name. Default: hob

Start application

Using shell

go run github.com/VlasovArtem/hob

Docker container

docker compose up -d