gustavofreze/account

Service responsible for managing account transactions.

Account

• Overview
  • Use cases
  • Queries
• Installation
  • Repository
  • Configuration
  • Tests
  • Review
  • Reports
• Environment setup
• Observability

Overview

Each cardholder (holder) has an account with their information. For each operation performed, a transaction is created and associated with the respective account. Transactions have specific types, e.g., Normal Purchase, Purchase with installments, Withdrawal, and Credit Voucher. Normal Purchase and Withdrawal transactions are recorded with negative values, while Credit Voucher transactions are recorded with positive values.

Figure 01: Account transaction flow diagram.

Use cases

• Account opening
• Account crediting
• Account debiting
• Account withdrawal

Queries

• Retrieve account balance
• Retrieve an account by id
• Retrieve account transactions

Installation

Repository

To clone the repository using the command line, run:

git clone https://github.com/gustavofreze/account.git

Configuration

To install project dependencies locally, run:

make configure

To start the application containers, run:

make start

To stop the application containers, run:

make stop

Tests

Run all tests with coverage:

make test 

Run all tests without coverage:

make test-no-coverage

Review

Run static code analysis:

make review 

Reports

Open static analysis reports (e.g., coverage, lints) in the browser:

make show-reports 

You can check other available commands by running make help.

Environment setup

Access URLs

Environment	DNS
Local	http://account.localhost

Database

Environment	URL	Port
Local	jdbc:mysql://localhost:3307	3307

Observability

You can access the application logs using the following command:

make show-logs