/fashion-tv

An API allowing you to search for TV shows by their name, using a simple query string.

Primary LanguagePHP

fashin-tv

Find your favorite tv show An API allowing you to search for TV shows by their name, using a simple query string.

Table of Contents

  1. Requirements
  2. Installation
  3. Built with
  4. REST API
  5. To-do
  6. WIP

Requirements

  • PHP 7.x
  • Composer
  • Laravel

⚠️ Caution: If use Laravel valet then do the required modifications

Install the dependencies

composer

Install Composer

laravel

Install Laravel

clone project

Start the app in development mode

git clone git@github.com:Atemndobs/fashion-tv.git

cd into project

cd fashion-tv

install the composer packages

composer install

start project

php artisan serve

or

make start

run tests

make test

visit api url

make api

REST API

local api

search tv show by giving title as query parameter

e.g search for outlander localhost:8000/api?q=outlander

outlander

To-do

  • Dockerise application to ease installation on different environment
  • Configure application for deployment / creating CI/CD pipeline for automated deployment
  • Generate api documentation e.g using apidoc-generator
  • Clean up project and remove unused files