KBC Futsal Lumen API is a RESTful backend service built with the Lumen PHP micro‑framework to manage futsal bookings, matches, and related operations.
It provides a lightweight, high‑performance foundation for mobile or web clients that need fast, JSON-based APIs.
The project follows common Laravel/Lumen conventions, making it easy to extend, maintain, and deploy.
- ⚽ Manage futsal grounds, time slots, teams, and bookings.
- 🔐 Token-based authentication (Laravel/Lumen ecosystem friendly).
- 📦 RESTful JSON API responses suitable for web and mobile clients.
- 🗄️ Database migrations and seeders for reproducible environments.
- ✅ Automated tests using PHPUnit.
- 🚀 Optimized for speed and low resource usage via the Lumen micro‑framework.
Note: Make sure the following screenshots exist under the
screenshots/directory or update the paths accordingly.
![]() |
![]() |
![]() |
|---|---|---|
| Caption 1 | Caption 2 | Caption 3 |
- PHP 7.3+ or 8.x
- Composer
- A database (e.g. MySQL/MariaDB)
- Git
-
Clone the repository
git clone https://github.com/abewartech/kbc-futsal-lumen.git cd kbc-futsal-lumen -
Install PHP dependencies
composer install
-
Copy environment file
cp .env.example .env
-
Configure environment
Edit
.envand set your database and application configuration:APP_NAME=KBC Futsal API APP_ENV=local APP_DEBUG=true APP_URL=http://localhost DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=kbc_futsal DB_USERNAME=root DB_PASSWORD=secret
-
Generate application key (if used)
Some installations of Lumen use
APP_KEYfor encryption. If applicable in this project, run:php artisan key:generate
-
Run database migrations (and seeders if available)
php artisan migrate php artisan db:seed # optional, if seeders are defined
You can use the built‑in PHP server or artisan (if configured):
php -S localhost:8000 -t public
# or, if "serve" is available
php artisan serveThe API will be available at:
http://localhost:8000
curl http://localhost:8000/api/slotsExample JSON response:
[
{
"id": 1,
"ground": "Main Court",
"starts_at": "2025-01-15T18:00:00Z",
"ends_at": "2025-01-15T19:00:00Z",
"is_available": true
}
]curl -X POST http://localhost:8000/api/bookings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
"slot_id": 1,
"team_name": "Genie FC"
}'A high‑level overview of the most important directories/files:
.
├── app/ # Application core (models, controllers, services)
├── bootstrap/ # Framework bootstrap and performance cache
├── database/ # Migrations, seeders, and factories
├── public/ # Public web root (index.php)
├── resources/ # Views, language files, other resources
├── routes/ # API and web route definitions
├── storage/ # Logs, cache, compiled views, etc.
├── tests/ # Automated tests (PHPUnit)
├── .env.example # Example environment configuration
├── composer.json # Project dependencies and scripts
└── README.md # Project documentation (this file)
Refer to the routes/ and app/ directories for the main API endpoints and application logic.
Core technologies and tools used in this project:
Contributions are welcome and appreciated.
- Fork the repository.
- Create a new feature branch:
git checkout -b feature/your-feature-name
- Make your changes, including tests where appropriate.
- Run the test suite:
phpunit
- Commit with a clear message and push your branch.
- Open a Pull Request describing your changes.
Please follow existing coding standards and conventions used in the project.
This project is open‑sourced software licensed under the MIT license.


