README.md

Local Setup

Requirements

• Python v14

• Docker + Docker Compose

• uv (Python project manager)

• psql CLI
  Install with:

  brew install postgresql

---

Setup Instructions

1. Clone the repository

git clone <repo>
cd bank-system

2. Configure environment variables

cp .env.example .env

3. Start PostgreSQL

make db-up

4. Run database migrations

make db-migrate

5. Install dependencies

uv sync

6. Install the app

uv pip install -e .

7. Run the API

make api

---

API Documentation

http://localhost:8000/docs

8. Run tests

Install test dependencies

uv sync --group test

Run tests

# All tests
pytest

# Specific test file
pytest tests/test_transactions.py

# Specific test
pytest tests/test_transactions.py::test__create_transfer__success