Football-api

Overview

A web application built with Laravel, Inertia.js, Vue 3, and Sail, designed to fetch and display football data from a third-party API. It features TanStack Table, ShadCN Vue, caching with Redis, integration via Saloon PHP, and structured models using Spatie Laravel Data.

Screenshots

Competitions list

Competition

Requirements

• Docker and Docker Compose installed.
• Account on Football Data to obtain an API key.

Installation

1. Clone the repository:

   [email protected]:amdlemos/football-api.git
   cd football-api

2. Install Composer dependencies:

   docker run --rm \
       -u "$(id -u):$(id -g)" \
       -v "$(pwd):/var/www/html" \
       -w /var/www/html \
       laravelsail/php83-composer:latest \
       composer install --ignore-platform-reqs

3. Copy the environment file and configure the API key:

   cp .env.example .env

   Edit the .env file and add the API key:

   FOOTBALL_DATA_API_KEY=yourapikeyhere

4. Start the application:

   vendor/bin/sail up

Access

• Application: localhost
• Laravel Telescope: localhost/telescope
• Laravel Pulse: localhost/pulse