https://github.com/edilsoncichon/banking-api
A simple REST API for bank account management (study project).
https://github.com/edilsoncichon/banking-api
ddd docker laravel php phpunit rest-api tdd tests
Last synced: about 2 months ago
JSON representation
A simple REST API for bank account management (study project).
- Host: GitHub
- URL: https://github.com/edilsoncichon/banking-api
- Owner: edilsoncichon
- Created: 2025-03-15T01:48:28.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-20T21:21:26.000Z (about 2 months ago)
- Last Synced: 2025-03-20T22:27:22.746Z (about 2 months ago)
- Topics: ddd, docker, laravel, php, phpunit, rest-api, tdd, tests
- Language: PHP
- Homepage:
- Size: 941 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](.doc/).
### 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:
- [Docker v28+](https://docs.docker.com/engine/install/)
- [Docker Compose](https://docs.docker.com/compose/)
### Installation Steps
1. Configure the `.env` file:
```bash
cp .env.example .env
```
2. Start Docker containers:
```bash
./sail up -d
```
3. Install Composer dependencies:
```bash
./sail composer install
```
4. Generate Laravel application key:
```bash
./sail artisan key:generate
```
5. Run migrations:
```bash
./sail artisan migrate
```
6. Restart containers:
```bash
./sail restart
```
---
> The API will be available at http://localhost/api.
## Code Quality
### Tests
To run automated tests, execute:
```bash
./sail test --coverage
```
### Code Standards Fixer
To check and fix syntax patterns, execute:
```bash
./sail pint
```
---