Skip to content

A simple REST API for bank account management (study project).

Notifications You must be signed in to change notification settings

edilsoncichon/banking-api

Repository files navigation

Logo

Banking API

This repository consists of a REST API for bank account management.

IMPORTANT: This is a project used for personal study purposes!

Documentation

For more details about requirements and business rules, see the project documentation.

Technologies used

  • PHP 8.2+
  • Composer 2
  • Laravel 12
  • MySQL 8
  • PHPUnit
  • PHP CS Fixer(via Laravel Pint)
  • Docker (via Laravel Sail)

Environment Setup

Follow these instructions to set up the development environment:

Prerequisites

Make sure you have installed:

Installation Steps

  1. Configure the .env file:

    cp .env.example .env
  2. Start Docker containers:

    ./sail up -d
  3. Install Composer dependencies:

    ./sail composer install
  4. Generate Laravel application key:

    ./sail artisan key:generate
  5. Run migrations:

    ./sail artisan migrate
  6. Restart containers:

    ./sail restart

The API will be available at http://localhost/api.

Code Quality

Tests

To run automated tests, execute:

./sail test --coverage

Code Standards Fixer

To check and fix syntax patterns, execute:

./sail pint