Skip to content

About

LUMEN VERSION ~~ Project Skripsi UNINDRA ~~ RANCANG BANGUN APLIKASI PENYEWAAN ONLINE LAPANGAN FUTSAL BERBASIS ANDROID pada KBC Futsal

Resources

Stars

11 stars

Watchers

1 watching

Forks

Repository files navigation

KBC Futsal Lumen API

GitHub tag (latest SemVer) License Build Status PHP Lumen

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.


Table of Contents


Features

  • ⚽ 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.

Screenshots

Note: Make sure the following screenshots exist under the screenshots/ directory or update the paths accordingly.

Screenshot 1 Screenshot 2 Screenshot 3
Caption 1 Caption 2 Caption 3

Installation

Prerequisites

  • PHP 7.3+ or 8.x
  • Composer
  • A database (e.g. MySQL/MariaDB)
  • Git

Steps

  1. Clone the repository

    git clone https://github.com/abewartech/kbc-futsal-lumen.git
    cd kbc-futsal-lumen
  2. Install PHP dependencies

    composer install
  3. Copy environment file

    cp .env.example .env
  4. Configure environment

    Edit .env and 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
  5. Generate application key (if used)

    Some installations of Lumen use APP_KEY for encryption. If applicable in this project, run:

    php artisan key:generate
  6. Run database migrations (and seeders if available)

    php artisan migrate
    php artisan db:seed   # optional, if seeders are defined

Usage

Start the development server

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 serve

The API will be available at:

http://localhost:8000

Example: Fetch available futsal slots

curl http://localhost:8000/api/slots

Example JSON response:

[
  {
    "id": 1,
    "ground": "Main Court",
    "starts_at": "2025-01-15T18:00:00Z",
    "ends_at": "2025-01-15T19:00:00Z",
    "is_available": true
  }
]

Example: Create a booking (authenticated)

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"
  }'

Project Structure

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.


Technologies

Core technologies and tools used in this project:

  • PHP
  • Lumen
  • Composer
  • MySQL
  • PHPUnit

Contributing

Contributions are welcome and appreciated.

  1. Fork the repository.
  2. Create a new feature branch:
    git checkout -b feature/your-feature-name
  3. Make your changes, including tests where appropriate.
  4. Run the test suite:
    phpunit
  5. Commit with a clear message and push your branch.
  6. Open a Pull Request describing your changes.

Please follow existing coding standards and conventions used in the project.


License

This project is open‑sourced software licensed under the MIT license.


GitAds Sponsored

Sponsored by GitAds

About

LUMEN VERSION ~~ Project Skripsi UNINDRA ~~ RANCANG BANGUN APLIKASI PENYEWAAN ONLINE LAPANGAN FUTSAL BERBASIS ANDROID pada KBC Futsal

Resources

Stars

11 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages