Onboarding - Third Challenge

• Introduction
• Built With
• Getting Started
  • Installation/Setup
  • Running
• Setting up 3rd-party Services

Introduction

The challenge the project was built on consists of a command line application that requests a movie name as a parameter to then be able to get information about it.

Built With

• PHP 8.1

Getting Started

Provide instructions on how to setup project locally. Example Installation/Setup and Running.

Installation/Setup

Follow these steps to setup the development environment...

• Run composer install
• cd into src
• Run cp AppSettings.php.example AppSettings.php
• Set AppSettings.php's OMDB_API_KEY const with your OMDb API Key

Running

• Initialize Docker
• cd into the project's root directory
• Run docker compose up -d
• Run docker exec -ti php-app sh
• Run ./application.php [movieName]. In case of wanting to get the full plot add the --fullPlot flag

Disclaimer: In case of permission denied error when executing the application.php file run chmod +x ./application.php to make it executable.

Setting up 3rd-party Services

• OMDb API: API service used for getting the movie information. Fill in this form and then follow the Installation/Setup steps.
• Docker: Download Docker Desktop and then follow the Running steps.